HF::Interfaces::ColourControl::MoveSaturationMessage Struct Reference

Move Saturation Message class. More...

#include <colour_control.h>

Collaboration diagram for HF::Interfaces::ColourControl::MoveSaturationMessage:

Public Member Functions
	MoveSaturationMessage (Direction dir=Direction::UP, uint8_t rate=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
Direction	direction
	Direction of movement. More...
uint8_t	rate
	Rate of change in degrees per second. More...

Static Public Attributes
static constexpr uint16_t	min_size
	Minimum pack/unpack required data size.

Detailed Description

Move Saturation Message class.

This class implements the necessary functions for message serialization.

Definition at line 602 of file colour_control.h.

Constructor & Destructor Documentation

MoveSaturationMessage()

HF::Interfaces::ColourControl::MoveSaturationMessage::MoveSaturationMessage ( Direction  dir = Direction::UP, uint8_t  rate = 0  )

inline

Constructor.

Parameters

[in]	dir	Direction of movement
[in]	rate	rate of change in degrees per second.

Definition at line 613 of file colour_control.h.

                                                                                :
               direction(dir), rate(rate)
            {}

Member Function Documentation

pack()

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

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.

size()

uint16_t HF::Interfaces::ColourControl::MoveSaturationMessage::size ( ) const

inline

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

Definition at line 622 of file colour_control.h.

References min_size.

            {
               return min_size;
            }

unpack()

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

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.

Field Documentation

direction

Direction HF::Interfaces::ColourControl::MoveSaturationMessage::direction

Direction of movement.

Definition at line 604 of file colour_control.h.

rate

uint8_t HF::Interfaces::ColourControl::MoveSaturationMessage::rate

Rate of change in degrees per second.

Definition at line 605 of file colour_control.h.

---

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

• colour_control.h