Simple Visual Effects

This module contains the classes that define and implement the Simple Visual Effects interface API. More...

Collaboration diagram for Simple Visual Effects:

Data Structures
struct	HF::Interfaces::SimpleVisualEffects::OnEffect
	This structure represents the parameters required for the ON_CMD effect. More...
struct	HF::Interfaces::SimpleVisualEffects::BlinkEffect
	This structure represents the parameters required for the BLICK_CMD effect. More...
struct	HF::Interfaces::SimpleVisualEffects::FadeEffect
	This structure represents the parameters required for the FADE_CMD effect. More...
struct	HF::Interfaces::SimpleVisualEffects::BreatheEffect
	This structure represents the parameters required for the BREATHE_CMD effect. More...
struct	HF::Interfaces::SimpleVisualEffects::Base
	Simple Visual Effects Interface : Parent. More...
class	HF::Interfaces::SimpleVisualEffects::Server
	Simple Visual Effects Interface : Server side implementation. More...
struct	HF::Interfaces::SimpleVisualEffects::Client
	Simple Visual Effects Interface : Client side implementation. More...

Enumerations
enum	HF::Interfaces::SimpleVisualEffects::CMD {   HF::Interfaces::SimpleVisualEffects::ON_CMD = 1, HF::Interfaces::SimpleVisualEffects::OFF_CMD = 2, HF::Interfaces::SimpleVisualEffects::BLINK_CMD = 3, HF::Interfaces::SimpleVisualEffects::FADE_CMD = 4,   HF::Interfaces::SimpleVisualEffects::BREATHE_CMD = 5 }
	Command IDs. More...

Functions
HF::Attributes::IAttribute *	HF::Interfaces::create_attribute (SimpleVisualEffects::Server *server, uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. More...
HF::Attributes::IAttribute *	HF::Interfaces::SimpleVisualEffects::create_attribute (uint8_t uid)
	Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleVisualEffects::Server *,uint8_t) More...
std::ostream &	operator<< (std::ostream &stream, const HF::Interfaces::SimpleVisualEffects::CMD command)
	Convert the given command into a string and write it to the given stream. More...

Detailed Description

This module contains the classes that define and implement the Simple Visual Effects interface API.

Enumeration Type Documentation

CMD

enum HF::Interfaces::SimpleVisualEffects::CMD

Command IDs.

Enumerator
ON_CMD	On command UID.
OFF_CMD	Off command UID.
BLINK_CMD	Blink command UID.
FADE_CMD	Fade command UID.
BREATHE_CMD	Breathe command UID.

Definition at line 63 of file simple_visual_effects.h.

         {
            ON_CMD       = 1, 
            OFF_CMD      = 2, 
            BLINK_CMD    = 3, 
            FADE_CMD     = 4, 
            BREATHE_CMD  = 5, 
            __LAST_CMD__ = BREATHE_CMD
         } CMD;

Function Documentation

create_attribute() [1/2]

HF::Attributes::IAttribute* HF::Interfaces::create_attribute	(	SimpleVisualEffects::Server *	server,
		uint8_t	uid
	)

Create an attribute object that can hold the attribute with the given uid.

If server is not equal to nullptr then initialize it with the current value.

Parameters

[in]	server	pointer to the object to read the current value from.
[in]	uid	attribute's UID to create the attribute object for.

Returns

pointer to an attribute object or nullptr if the attribute UID does not exist.

create_attribute() [2/2]

HF::Attributes::IAttribute* HF::Interfaces::SimpleVisualEffects::create_attribute ( uint8_t  uid )

inline

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleVisualEffects::Server *,uint8_t)

See also

HF::Interfaces::create_attribute (HF::Interfaces::SimpleVisualEffects::Server *,uint8_t)

Parameters

[in]

uid

attribute UID to create the attribute object for.

Return values

pointer	to an attribute object
<tt>nullptr</tt>	if the attribute UID does not exist.

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleVisualEffects::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleThermostat::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimplePowerMeter::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleLightSensor::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleKeypad::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleButton::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleAirPressure::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::OnOff::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::LevelControl::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::ColourControl::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::Alert::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Weekly::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::Time::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SUOTA::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::RSSI::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::GroupTable::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid.

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Event::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceManagement::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceInformation::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::BindManagement::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::BatchProgramManagement::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::AttributeReporting::Server *,uint8_t)

See also

HF::Interfaces::create_attribute (HF::Interfaces::SimpleHumidity::Server *,uint8_t)

Parameters

[in]

uid

attribute UID to create the attribute object for.

Returns

pointer to an attribute object or nullptr if the attribute UID does not exist.

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleVisualEffects::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleThermostat::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimplePowerMeter::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleLightSensor::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleKeypad::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleButton::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SimpleAirPressure::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::OnOff::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::LevelControl::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::ColourControl::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::Alert::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Weekly::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::Time::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::SUOTA::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Interfaces::RSSI::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::GroupTable::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid.

Create an attribute object that can hold the attribute with the given uid. (HF::Core::Scheduling::Event::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceManagement::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::DeviceInformation::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::BindManagement::Server *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::BatchProgramManagement::IServer *,uint8_t)

Create an attribute object that can hold the attribute with the given uid. (HF::Core::AttributeReporting::Server *,uint8_t)

See also

HF::Interfaces::create_attribute (HF::Interfaces::SimpleTemperature::Server *,uint8_t)

Parameters

[in]

uid

attribute UID to create the attribute object for.

Return values

pointer	to an attribute object
<tt>nullptr</tt>	if the attribute UID does not exist.

Definition at line 108 of file simple_humidity.h.

References HF::Interfaces::create_attribute().

         {
            return Interfaces::create_attribute(static_cast<SimpleHumidity::Server *>(nullptr),
                                                uid);
         }

Here is the call graph for this function:

operator<<()

std::ostream& operator<<	(	std::ostream &	stream,
		const HF::Interfaces::SimpleVisualEffects::CMD	command
	)

Convert the given command into a string and write it to the given stream.

Parameters

[in]	stream	out stream to write the string to.
[in]	command	role value to convert to a string.

Returns

stream