Builder for constructing CoLaCommands. More...

#include <CoLaParameterWriter.h>

Public Member Functions
const CoLaCommand	build ()

	CoLaParameterWriter (CoLaCommandType::Enum type, const char *name)
	Construct a new CoLaParameterWriter. More...

CoLaParameterWriter &	operator<< (const bool boolean)
	Add a boolean as a byte, with 0 representing false, and 1 representing true. More...

CoLaParameterWriter &	operator<< (const char *str)
	Add a string parameter, must be null-terminated. More...

CoLaParameterWriter &	operator<< (const double lReal)
	Add a IEEE-754 double precision (64-bit). More...

CoLaParameterWriter &	operator<< (const float real)
	Add a IEEE-754 single precision (32-bit). More...

CoLaParameterWriter &	operator<< (const int16_t integer)
	Add a signed int (16-bit). More...

CoLaParameterWriter &	operator<< (const int32_t dInt)
	Add an signed double int (32-bit). More...

CoLaParameterWriter &	operator<< (const int8_t sInt)
	Add a signed short (8-bit, range [-128, 127]). More...

CoLaParameterWriter &	operator<< (const uint16_t uInt)
	Add a unsigned int (16-bit, range [0, 65535]). More...

CoLaParameterWriter &	operator<< (const uint32_t uDInt)
	Add an unsigned double int (32-bit, range [0, 4294967295]). More...

CoLaParameterWriter &	operator<< (const uint8_t uSInt)
	Add a unsigned short (8-bit, range [0, 255]). More...

CoLaParameterWriter &	parameterBool (const bool boolean)
	Add a boolean as a byte, with 0 representing false, and 1 representing true. More...

CoLaParameterWriter &	parameterDInt (const int32_t dInt)
	Add an signed double int (32-bit). More...

CoLaParameterWriter &	parameterFlexString (const std::string &str)
	Add a string as a flex string. More...

CoLaParameterWriter &	parameterInt (const int16_t integer)
	Add a signed int (16-bit). More...

CoLaParameterWriter &	parameterLReal (const double lReal)
	Add a IEEE-754 double precision (64-bit). More...

CoLaParameterWriter &	parameterPasswordMD5 (const std::string &str)
	Add the given password as a UDInt, using MD5 hashing. More...

CoLaParameterWriter &	parameterReal (const float real)
	Add a IEEE-754 single precision (32-bit). More...

CoLaParameterWriter &	parameterSInt (const int8_t sInt)
	Add a signed short (8-bit, range [-128, 127]). More...

CoLaParameterWriter &	parameterUDInt (const uint32_t uDInt)
	Add an unsigned double int (32-bit, range [0, 4294967295]). More...

CoLaParameterWriter &	parameterUInt (const uint16_t uInt)
	Add a unsigned int (16-bit, range [0, 65535]). More...

CoLaParameterWriter &	parameterUSInt (const uint8_t uSInt)
	Add a unsigned short (8-bit, range [0, 255]). More...

	~CoLaParameterWriter ()

Private Member Functions
void	writeHeader (CoLaCommandType::Enum type, const char *name)

Private Attributes
std::vector< uint8_t >	m_buffer

const char *	m_name

CoLaCommandType::Enum	m_type

Detailed Description

Builder for constructing CoLaCommands.

Definition at line 19 of file CoLaParameterWriter.h.

Constructor & Destructor Documentation

◆ CoLaParameterWriter()

visionary::CoLaParameterWriter::CoLaParameterWriter	(	CoLaCommandType::Enum	type,
		const char *	name
	)

Construct a new CoLaParameterWriter.

Parameters

type	Type of command.
name	The command, e.g. for methods this should be the "communication name" from the CID.

Definition at line 17 of file CoLaParameterWriter.cpp.

◆ ~CoLaParameterWriter()

visionary::CoLaParameterWriter::~CoLaParameterWriter ( )

default

Member Function Documentation

◆ build()

const CoLaCommand visionary::CoLaParameterWriter::build ( )

Definition at line 181 of file CoLaParameterWriter.cpp.

◆ operator<<() [1/10]

CoLaParameterWriter & visionary::CoLaParameterWriter::operator<< ( const bool boolean )

Add a boolean as a byte, with 0 representing false, and 1 representing true.

Parameters

boolean Boolean to add.

Returns: This builder.

Definition at line 176 of file CoLaParameterWriter.cpp.

◆ operator<<() [2/10]

CoLaParameterWriter & visionary::CoLaParameterWriter::operator<< ( const char * str )

Add a string parameter, must be null-terminated.

Parameters

str	String to add.

Returns: This builder.

Definition at line 130 of file CoLaParameterWriter.cpp.

◆ operator<<() [3/10]

CoLaParameterWriter & visionary::CoLaParameterWriter::operator<< ( const double lReal )

Add a IEEE-754 double precision (64-bit).

Parameters

lReal Long real to add.

Returns: This builder.

Definition at line 171 of file CoLaParameterWriter.cpp.

◆ operator<<() [4/10]

CoLaParameterWriter & visionary::CoLaParameterWriter::operator<< ( const float real )

Add a IEEE-754 single precision (32-bit).

Parameters

real	Real to add.

Returns: This builder.

Definition at line 166 of file CoLaParameterWriter.cpp.

◆ operator<<() [5/10]

CoLaParameterWriter & visionary::CoLaParameterWriter::operator<< ( const int16_t integer )

Add a signed int (16-bit).

Parameters

integer Int to add.

Returns: This builder.

Definition at line 146 of file CoLaParameterWriter.cpp.

◆ operator<<() [6/10]

CoLaParameterWriter & visionary::CoLaParameterWriter::operator<< ( const int32_t dInt )

Add an signed double int (32-bit).

Parameters

dInt	dInt to add.

Returns: This builder.

Definition at line 156 of file CoLaParameterWriter.cpp.

◆ operator<<() [7/10]

CoLaParameterWriter & visionary::CoLaParameterWriter::operator<< ( const int8_t sInt )

Add a signed short (8-bit, range [-128, 127]).

Parameters

sInt	SInt to add

Returns: This builder.

Definition at line 136 of file CoLaParameterWriter.cpp.

◆ operator<<() [8/10]

CoLaParameterWriter & visionary::CoLaParameterWriter::operator<< ( const uint16_t uInt )

Add a unsigned int (16-bit, range [0, 65535]).

Parameters

uInt	UInt to add.

Returns: This builder.

Definition at line 151 of file CoLaParameterWriter.cpp.

◆ operator<<() [9/10]

CoLaParameterWriter & visionary::CoLaParameterWriter::operator<< ( const uint32_t uDInt )

Add an unsigned double int (32-bit, range [0, 4294967295]).

Parameters

uDInt UDInt to add.

Returns: This builder.

Definition at line 161 of file CoLaParameterWriter.cpp.

◆ operator<<() [10/10]

CoLaParameterWriter & visionary::CoLaParameterWriter::operator<< ( const uint8_t uSInt )

Add a unsigned short (8-bit, range [0, 255]).

Parameters

uSInt USInt to add.

Returns: This builder.

Definition at line 141 of file CoLaParameterWriter.cpp.

◆ parameterBool()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterBool ( const bool boolean )

Add a boolean as a byte, with 0 representing false, and 1 representing true.

Parameters

boolean Boolean to add.

Returns: This builder.

Definition at line 90 of file CoLaParameterWriter.cpp.

◆ parameterDInt()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterDInt ( const int32_t dInt )

Add an signed double int (32-bit).

Parameters

dInt	dInt to add.

Returns: This builder.

Definition at line 54 of file CoLaParameterWriter.cpp.

◆ parameterFlexString()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterFlexString ( const std::string & str )

Add a string as a flex string.

Parameters

str	String to add.

Returns: This builder.

Definition at line 115 of file CoLaParameterWriter.cpp.

◆ parameterInt()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterInt ( const int16_t integer )

Add a signed int (16-bit).

Parameters

integer Int to add.

Returns: This builder.

Definition at line 36 of file CoLaParameterWriter.cpp.

◆ parameterLReal()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterLReal ( const double lReal )

Add a IEEE-754 double precision (64-bit).

Parameters

lReal Long real to add.

Returns: This builder.

Definition at line 81 of file CoLaParameterWriter.cpp.

◆ parameterPasswordMD5()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterPasswordMD5 ( const std::string & str )

Add the given password as a UDInt, using MD5 hashing.

Parameters

str	String to hash and add as parameter.

Returns: This builder.

Definition at line 96 of file CoLaParameterWriter.cpp.

◆ parameterReal()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterReal ( const float real )

Add a IEEE-754 single precision (32-bit).

Parameters

real	Real to add.

Returns: This builder.

Definition at line 72 of file CoLaParameterWriter.cpp.

◆ parameterSInt()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterSInt ( const int8_t sInt )

Add a signed short (8-bit, range [-128, 127]).

Parameters

sInt	SInt to add

Returns: This builder.

Definition at line 24 of file CoLaParameterWriter.cpp.

◆ parameterUDInt()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterUDInt ( const uint32_t uDInt )

Add an unsigned double int (32-bit, range [0, 4294967295]).

Parameters

uDInt UDInt to add.

Returns: This builder.

Definition at line 63 of file CoLaParameterWriter.cpp.

◆ parameterUInt()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterUInt ( const uint16_t uInt )

Add a unsigned int (16-bit, range [0, 65535]).

Parameters

uInt	UInt to add.

Returns: This builder.

Definition at line 45 of file CoLaParameterWriter.cpp.

◆ parameterUSInt()

CoLaParameterWriter & visionary::CoLaParameterWriter::parameterUSInt ( const uint8_t uSInt )

Add a unsigned short (8-bit, range [0, 255]).

Parameters

uSInt USInt to add.

Returns: This builder.

Definition at line 30 of file CoLaParameterWriter.cpp.

◆ writeHeader()

void visionary::CoLaParameterWriter::writeHeader	(	CoLaCommandType::Enum	type,
		const char *	name
	)

private

Definition at line 189 of file CoLaParameterWriter.cpp.

Member Data Documentation

◆ m_buffer

std::vector<uint8_t> visionary::CoLaParameterWriter::m_buffer

private

Definition at line 24 of file CoLaParameterWriter.h.

◆ m_name

const char* visionary::CoLaParameterWriter::m_name

private

Definition at line 23 of file CoLaParameterWriter.h.

◆ m_type

CoLaCommandType::Enum visionary::CoLaParameterWriter::m_type

private

Definition at line 22 of file CoLaParameterWriter.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CoLaParameterWriter()

◆ ~CoLaParameterWriter()

Member Function Documentation

◆ build()

◆ operator<<() [1/10]

◆ operator<<() [2/10]

◆ operator<<() [3/10]

◆ operator<<() [4/10]

◆ operator<<() [5/10]

◆ operator<<() [6/10]

◆ operator<<() [7/10]

◆ operator<<() [8/10]

◆ operator<<() [9/10]

◆ operator<<() [10/10]

◆ parameterBool()

◆ parameterDInt()

◆ parameterFlexString()

◆ parameterInt()

◆ parameterLReal()

◆ parameterPasswordMD5()

◆ parameterReal()

◆ parameterSInt()

◆ parameterUDInt()

◆ parameterUInt()

◆ parameterUSInt()

◆ writeHeader()

Member Data Documentation

◆ m_buffer

◆ m_name

◆ m_type