NAP
Public Member Functions | Public Attributes | List of all members
WeeklyCalendarItem Class Reference

#include <calendaritem.h>

Public Member Functions

 WeeklyCalendarItem ()=default
 
 WeeklyCalendarItem (const CalendarItem::Point &point, const std::string &title, EDay day)
 
bool init (utility::ErrorState &errorState) override
 
bool setDay (EDay day)
 
EDay getDay () const
 
virtual bool active (SystemTimeStamp timeStamp) const override
 
- Public Member Functions inherited from CalendarItem
 CalendarItem ()=default
 
 CalendarItem (const Point &point, const std::string &title)
 
void setTitle (const std::string &title)
 
const std::string & getTitle () const
 
void setDescription (const std::string &description)
 
const std::string & getDescription () const
 
bool setPoint (const Point &point)
 
const PointgetPoint () const
 
bool setTime (const Time &time)
 
const TimegetTime () const
 
void setDuration (const Time &duration)
 
const TimegetDuration () const
 
- Public Member Functions inherited from Resource
 Resource ()
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
virtual void onDestroy ()
 
 Object (Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&)=delete
 
Objectoperator= (Object &&)=delete
 

Public Attributes

EDay mDay = EDay::Monday
 Property: 'Day' day of the week. More...
 
- Public Attributes inherited from CalendarItem
std::string mTitle = ""
 Property: 'Title' item title. More...
 
Point mPoint
 Property; 'Point' point in time together with duration. More...
 
std::string mDescription = ""
 Property: 'Description' item description. 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)
 

Description

Weekly recurring calendar item. For example: Store opening hours.

Inheritance diagram for WeeklyCalendarItem:
[legend]
Collaboration diagram for WeeklyCalendarItem:
[legend]

Constructor & Destructor Documentation

◆ WeeklyCalendarItem() [1/2]

WeeklyCalendarItem ( )
default

◆ WeeklyCalendarItem() [2/2]

WeeklyCalendarItem ( const CalendarItem::Point point,
const std::string &  title,
EDay  day 
)

Member Function Documentation

◆ active()

virtual bool active ( SystemTimeStamp  timeStamp) const
overridevirtual
Parameters
timeStamptime to validate
Returns
if the weekly calender item currently occurs.

Implements CalendarItem.

◆ getDay()

EDay getDay ( ) const
Returns
the day of the week

◆ init()

bool init ( utility::ErrorState errorState)
overridevirtual

Initializes the weekly calendar item. Checks if the day and time are valid.

Returns
if the day and time are valid

Reimplemented from CalendarItem.

◆ setDay()

bool setDay ( EDay  day)

Updates the day of the week

Parameters
daythe new day of the week
Returns
if the day of the week is updated

Member Data Documentation

◆ mDay

Property: 'Day' day of the week.