OperationalCalendar Class Reference

#include <operationalcalendar.h>

Public Member Functions
	OperationalCalendar (nap::Core &core)
virtual	~OperationalCalendar ()
virtual bool	init (utility::ErrorState &errorState) override
CalendarInstance &	getInstance () override
const CalendarInstance &	getInstance () const override
bool	isOperational ()
Public Member Functions inherited from ICalendar
	ICalendar (nap::Core &core)
Public Member Functions inherited from Resource
	Resource ()
Public Member Functions inherited from Object
	Object ()
virtual	~Object ()
virtual void	onDestroy ()
	Object (Object &)=delete
Object &	operator= (const Object &)=delete
	Object (Object &&)=delete
Object &	operator= (Object &&)=delete

Public Attributes
bool	mAllowFailure = true
	Property: 'AllowLoadFailure' If initialization continues when loading a calendar from disk fails. In that case resource defaults are used. More...
CalendarItem::Point	mMonday
	Property: 'Monday' Monday operational hours. More...
CalendarItem::Point	mTuesday
	Property: 'Tuesday' Tuesday operational hours. More...
CalendarItem::Point	mWednesday
	Property: 'Wednesday' Wednesday operational hours. More...
CalendarItem::Point	mThursday
	Property: 'Thursday' Thursday operational hours. More...
CalendarItem::Point	mFriday
	Property: 'Friday' Friday operational hours. More...
CalendarItem::Point	mSaturday
	Property: 'Saturday' Saturday operational hours. More...
CalendarItem::Point	mSunday
	Property: 'Sunday' Sunday operational hours. More...
Public Attributes inherited from Object
std::string	mID
	Property: 'mID' unique name of the object. Used as an identifier by the system. More...

Additional Inherited Members
Static Public Member Functions inherited from Object
static bool	isIDProperty (rtti::Instance &object, const rtti::Property &property)
Protected Attributes inherited from ICalendar
nap::Core &	mCore
	NAP core. More...

Description

Special, but common, type of calendar. Allows you to define and inspect, for every day of the week, when something is in operation. If you want more control use the regular nap::Calendar instead. The title of every created item is the 'nap::EDay' of the week, the ID is unique.

Inheritance diagram for OperationalCalendar:

Collaboration diagram for OperationalCalendar:

Constructor & Destructor Documentation

OperationalCalendar()

OperationalCalendar

(

nap::Core &

core

)

~OperationalCalendar()

virtual ~OperationalCalendar ( )

virtual

Member Function Documentation

getInstance() [1/2]

const CalendarInstance& getInstance ( ) const

overridevirtual

Returns

the calendar instance, only available after initialization

Implements ICalendar.

getInstance() [2/2]

CalendarInstance& getInstance ( )

overridevirtual

Returns

the calendar instance, only available after initialization

Implements ICalendar.

init()

virtual bool init ( utility::ErrorState &  errorState )

overridevirtual

Creates and initializes the operational calendar instance

Returns

if initialization succeeded

Reimplemented from Object.

isOperational()

bool isOperational

(

)

Returns

if, for any day of the week, an item is currently active.

Member Data Documentation

mAllowFailure

bool mAllowFailure = true

Property: 'AllowLoadFailure' If initialization continues when loading a calendar from disk fails. In that case resource defaults are used.

mFriday

CalendarItem::Point mFriday

Property: 'Friday' Friday operational hours.

mMonday

CalendarItem::Point mMonday

Property: 'Monday' Monday operational hours.

mSaturday

CalendarItem::Point mSaturday

Property: 'Saturday' Saturday operational hours.

mSunday

CalendarItem::Point mSunday

Property: 'Sunday' Sunday operational hours.

mThursday

CalendarItem::Point mThursday

Property: 'Thursday' Thursday operational hours.

mTuesday

CalendarItem::Point mTuesday

Property: 'Tuesday' Tuesday operational hours.

mWednesday

CalendarItem::Point mWednesday

Property: 'Wednesday' Wednesday operational hours.