NAP
Public Member Functions | List of all members
DailyCalendarItem Class Reference

#include <calendaritem.h>

Public Member Functions

 DailyCalendarItem ()=default
 
 DailyCalendarItem (const CalendarItem::Point &point, const std::string &title)
 
bool init (utility::ErrorState &errorState) override
 
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
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static bool isIDProperty (rtti::Instance &object, const rtti::Property &property)
 
- 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...
 

Description

Daily recurring calendar item. For example: watering the plants or an alarm clock.

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

Constructor & Destructor Documentation

◆ DailyCalendarItem() [1/2]

DailyCalendarItem ( )
default

◆ DailyCalendarItem() [2/2]

DailyCalendarItem ( const CalendarItem::Point point,
const std::string &  title 
)

Member Function Documentation

◆ active()

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

Implements CalendarItem.

◆ init()

bool init ( utility::ErrorState errorState)
overridevirtual

Initializes the daily calendar item. Checks if the time is valid.

Returns
if the time is valid

Reimplemented from CalendarItem.