TwilightBehaviour Class Reference

#include <cs_TwilightBehaviour.h>

Inheritance diagram for TwilightBehaviour:

Collaboration diagram for TwilightBehaviour:

Public Types
typedef std::array< uint8_t, WireFormat::size< Behaviour >()>	SerializedDataType
Public Types inherited from Behaviour
enum class	Type : uint8_t { Switch = 0 , Twilight = 1 , Extended = 2 , Undefined = 0xff }
typedef std::array< uint8_t, 1+13 >	SerializedDataType

Public Member Functions
virtual	~TwilightBehaviour ()=default
	TwilightBehaviour (uint8_t intensity, uint8_t profileid, DayOfWeekBitMask activedaysofweek, TimeOfDay from, TimeOfDay until)
	TwilightBehaviour (SerializedDataType arr)
SerializedDataType	serialize ()
virtual uint8_t *	serialize (uint8_t *outbuff, size_t max_size) override
virtual size_t	serializedSize () const override
virtual void	print () override
virtual Type	getType () const override
bool	isValid (Time currenttime)
	Does the behaviour apply to the current situation? If from() == until() the behaviour isValid all day. More...
Public Member Functions inherited from Behaviour
virtual	~Behaviour ()=default
	Behaviour (Type typ, uint8_t intensity, uint8_t profileid, DayOfWeekBitMask activedaysofweek, TimeOfDay from, TimeOfDay until)
	Behaviour (SerializedDataType arr)
SerializedDataType	serialize ()
virtual uint8_t *	serialize (uint8_t *outbuff, size_t max_size)
virtual size_t	serializedSize () const
std::vector< uint8_t >	serialized ()
virtual void	print ()
virtual Type	getType () const
bool	isValid (Time currenttime)
	Does the behaviour apply to the current situation? If from() == until() the behaviour isValid all day. More...
virtual bool	requiresPresence ()
virtual bool	requiresAbsence ()
uint8_t	value () const
	Returns the intended state when this behaviour is valid. More...
TimeOfDay	from () const
	Returns from (incl.) which time on this behaviour applies. More...
TimeOfDay	until () const
	Returns until (excl.) which time on this behaviour applies. More...

Additional Inherited Members
Protected Attributes inherited from Behaviour
Type	typ
uint8_t	activeIntensity = 0
uint8_t	profileId = 0
DayOfWeekBitMask	activeDays
TimeOfDay	behaviourAppliesFrom = TimeOfDay::Midnight()
TimeOfDay	behaviourAppliesUntil = TimeOfDay::Midnight()

Member Typedef Documentation

SerializedDataType

typedef std::array<uint8_t, WireFormat::size<Behaviour>()> TwilightBehaviour::SerializedDataType

Constructor & Destructor Documentation

~TwilightBehaviour()

virtual TwilightBehaviour::~TwilightBehaviour ( )

virtualdefault

TwilightBehaviour() [1/2]

TwilightBehaviour::TwilightBehaviour	(	uint8_t	intensity,
		uint8_t	profileid,
		DayOfWeekBitMask	activedaysofweek,
		TimeOfDay	from,
		TimeOfDay	until
	)

TwilightBehaviour() [2/2]

TwilightBehaviour::TwilightBehaviour

(

SerializedDataType

arr

)

Member Function Documentation

getType()

virtual Type TwilightBehaviour::getType ( ) const

inlineoverridevirtual

Reimplemented from Behaviour.

isValid()

bool Behaviour::isValid

(

Time

currenttime

)

Does the behaviour apply to the current situation? If from() == until() the behaviour isValid all day.

Also checks the day of week bitmask.

print()

virtual void TwilightBehaviour::print ( )

overridevirtual

Reimplemented from Behaviour.

serialize() [1/2]

SerializedDataType TwilightBehaviour::serialize

(

)

serialize() [2/2]

virtual uint8_t * TwilightBehaviour::serialize ( uint8_t *  outbuff, size_t  max_size  )

overridevirtual

Reimplemented from Behaviour.

serializedSize()

virtual size_t TwilightBehaviour::serializedSize ( ) const

overridevirtual

Reimplemented from Behaviour.

---

The documentation for this class was generated from the following file:

• source/include/behaviour/cs_TwilightBehaviour.h