HF::Interfaces::SimpleVisualEffects::OnEffect Struct Reference

This structure represents the parameters required for the ON_CMD effect. More...

#include <simple_visual_effects.h>

Collaboration diagram for HF::Interfaces::SimpleVisualEffects::OnEffect:

Public Member Functions
	OnEffect (uint16_t _duration=0)
	Constructor. More...
uint16_t	size () const
	Number bytes needed to serialize the message. More...
uint16_t	pack (Common::ByteArray &array, uint16_t offset=0) const
	Write the object on to a ByteArray so it can be sent over the network. More...
uint16_t	unpack (const Common::ByteArray &array, uint16_t offset=0)
	Read a message from a ByteArray. More...

Data Fields
uint16_t	duration
	How long to keep the visual indicator ON in miliseconds. More...

Static Public Attributes
static constexpr uint16_t	min_size = sizeof(uint16_t)
	Minimum pack/unpack required data size.

Detailed Description

This structure represents the parameters required for the ON_CMD effect.

Definition at line 80 of file simple_visual_effects.h.

Constructor & Destructor Documentation

OnEffect()

HF::Interfaces::SimpleVisualEffects::OnEffect::OnEffect ( uint16_t  _duration = 0 )

inline

Constructor.

Parameters

[in]

_duration

number of miliseconds for the ON_CMD

Definition at line 89 of file simple_visual_effects.h.

: duration(_duration) {}

Member Function Documentation

pack()

uint16_t HF::Interfaces::SimpleVisualEffects::OnEffect::pack ( Common::ByteArray &  array, uint16_t  offset = 0  ) const

inline

Write the object on to a ByteArray so it can be sent over the network.

The buffer passed in MUST have enough size to hold the serialized object, e.g.,

Serializable obj;
ByteArray payload(obj.size());
obj.pack(payload);

Parameters

[in,out]	array	ByteArray reference to write the object to.
[in]	offset	offset to start writing to.

Returns

the number of bytes written.

Definition at line 101 of file simple_visual_effects.h.

References duration, HF_SERIALIZABLE_CHECK, min_size, and HF::Common::ByteArray::write().

            {
               HF_SERIALIZABLE_CHECK(array, offset, min_size);

               array.write(offset, duration);

               return min_size;
            }

Here is the call graph for this function:

size()

uint16_t HF::Interfaces::SimpleVisualEffects::OnEffect::size ( ) const

inline

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

Definition at line 95 of file simple_visual_effects.h.

References min_size.

            {
               return min_size;
            }

unpack()

uint16_t HF::Interfaces::SimpleVisualEffects::OnEffect::unpack ( const Common::ByteArray &  array, uint16_t  offset = 0  )

inline

Read a message from a ByteArray.

Parameters

[in]	array	ByteArray reference to read the message from.
[in]	offset	offset to start reading from.

Returns

the number of bytes read.

Definition at line 111 of file simple_visual_effects.h.

References duration, HF_SERIALIZABLE_CHECK, min_size, and HF::Common::ByteArray::read().

            {
               HF_SERIALIZABLE_CHECK(array, offset, min_size);

               array.read(offset, duration);

               return min_size;
            }

Here is the call graph for this function:

Field Documentation

duration

uint16_t HF::Interfaces::SimpleVisualEffects::OnEffect::duration

How long to keep the visual indicator ON in miliseconds.

Definition at line 82 of file simple_visual_effects.h.

Referenced by pack(), and unpack().

---

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

• simple_visual_effects.h