HF::Interfaces::ColourControl::StepXYMessage Struct Reference

Step XY Message class. More...

#include <colour_control.h>

Collaboration diagram for HF::Interfaces::ColourControl::StepXYMessage:

Public Member Functions
	StepXYMessage (int16_t X_step=0, int16_t Y_step=0, uint8_t time=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
int16_t	X_step
	The step size for X. More...
int16_t	Y_step
	The step size for Y. More...
uint8_t	time
	Time of a single step transition (units of 100msec). More...

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

Detailed Description

Step XY Message class.

This class implements the necessary functions for message serialization.

Definition at line 798 of file colour_control.h.

Constructor & Destructor Documentation

StepXYMessage()

HF::Interfaces::ColourControl::StepXYMessage::StepXYMessage ( int16_t  X_step = 0, int16_t  Y_step = 0, uint8_t  time = 0  )

inline

Constructor.

Parameters

[in]	X_step	the step size for X.
[in]	Y_step	the step size for Y.
[in]	time	time of a single step transition (units of 100msec).

Definition at line 811 of file colour_control.h.

                                                                                   :
               X_step(X_step), Y_step(Y_step), time(time)
            {}

Member Function Documentation

pack()

uint16_t HF::Interfaces::ColourControl::StepXYMessage::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::StepXYMessage::size ( ) const

inline

Number bytes needed to serialize the message.

Returns

number of bytes the message requires to be serialized.

Definition at line 821 of file colour_control.h.

References min_size.

            {
               return min_size;
            }

unpack()

uint16_t HF::Interfaces::ColourControl::StepXYMessage::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

time

uint8_t HF::Interfaces::ColourControl::StepXYMessage::time

Time of a single step transition (units of 100msec).

Definition at line 802 of file colour_control.h.

X_step

int16_t HF::Interfaces::ColourControl::StepXYMessage::X_step

The step size for X.

Definition at line 800 of file colour_control.h.

Y_step

int16_t HF::Interfaces::ColourControl::StepXYMessage::Y_step

The step size for Y.

Definition at line 801 of file colour_control.h.

---

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

• colour_control.h