Detailed Description

SOI Command.

Public Types
enum	TypeEnum { SOITYPE_REQUEST, SOITYPE_SUCCESS, SOITYPE_ERROR }

enum	CommandEnum { SOICMD_EXEC, SOICMD_STOP, SOICMD_SET_PARAMS, SOICMD_GET_PARAMS, SOICMD_GET_PLAN, SOICMD_RESUME }

Public Member Functions
	SoiCommand (void)

SoiCommand *	clone (void) const

void	clear (void)

bool	fieldsEqual (const Message &msg__) const

int	validate (void) const

uint8_t *	serializeFields (uint8_t *bfr__) const

uint16_t	deserializeFields (const uint8_t *bfr__, uint16_t size__)

uint16_t	reverseDeserializeFields (const uint8_t *bfr__, uint16_t size__)

uint16_t	getId (void) const

const char *	getName (void) const

unsigned	getFixedSerializationSize (void) const

unsigned	getVariableSerializationSize (void) const

void	fieldsToJSON (std::ostream &os__, unsigned nindent__) const

Public Member Functions inherited from DUNE::IMC::Message
	Message (void)

virtual	~Message (void)

double	setTimeStamp (double ts)

double	setTimeStamp (void)

double	getTimeStamp (void) const

uint16_t	getSource (void) const

void	setSource (uint16_t src)

uint8_t	getSourceEntity (void) const

void	setSourceEntity (uint8_t src_ent)

uint16_t	getDestination (void) const

void	setDestination (uint16_t dst)

uint8_t	getDestinationEntity (void) const

void	setDestinationEntity (uint8_t dst_ent)

virtual uint16_t	getSubId (void) const

virtual void	setSubId (uint16_t subid)

virtual fp64_t	getValueFP (void) const

virtual void	setValueFP (fp64_t val)

unsigned	getSerializationSize (void) const

unsigned	getPayloadSerializationSize (void) const

void	toJSON (std::ostream &os) const

void	toText (std::ostream &os) const

bool	operator== (const Message &other) const

bool	operator!= (const Message &other) const

Static Public Member Functions
static uint16_t	getIdStatic (void)

Public Attributes
uint8_t	type

uint8_t	command

std::string	settings

InlineMessage< SoiPlan >	plan

std::string	info

Protected Member Functions
void	setTimeStampNested (double value__)

void	setSourceNested (uint16_t value__)

void	setSourceEntityNested (uint8_t value__)

void	setDestinationNested (uint16_t value__)

void	setDestinationEntityNested (uint8_t value__)

Additional Inherited Members
Protected Attributes inherited from DUNE::IMC::Message
Header	m_header

Member Enumeration Documentation

enum DUNE::IMC::SoiCommand::CommandEnum

Command.

Enumerator
SOICMD_EXEC	Execute Plan.
SOICMD_STOP	Stop Execution.
SOICMD_SET_PARAMS	Set Parameters.
SOICMD_GET_PARAMS	Get Parameters.
SOICMD_GET_PLAN	Get Plan.
SOICMD_RESUME	Resume Execution.

enum DUNE::IMC::SoiCommand::TypeEnum

Type.

Enumerator
SOITYPE_REQUEST	Request.
SOITYPE_SUCCESS	Success.
SOITYPE_ERROR	Error.

Constructor & Destructor Documentation

DUNE::IMC::SoiCommand::SoiCommand ( void )

References clear(), DUNE::IMC::Message::m_header, DUNE::IMC::Header::mgid, and plan.

Referenced by clone().

Member Function Documentation

void DUNE::IMC::SoiCommand::clear ( void )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References command, info, plan, settings, and type.

Referenced by SoiCommand().

SoiCommand* DUNE::IMC::SoiCommand::clone ( void ) const

inlinevirtual

Retrieve a copy of the message.

Returns: message copy.

Implements DUNE::IMC::Message.

References SoiCommand().

uint16_t DUNE::IMC::SoiCommand::deserializeFields	(	const uint8_t *	bfr,
		uint16_t	len
	)

virtual

Deserialize message fields from a packet.

Parameters

bfr	stream of bytes (packet)
len	length of the byte stream.

Returns: number of bytes processed.

Implements DUNE::IMC::Message.

References command, DUNE::IMC::deserialize(), info, plan, settings, and type.

bool DUNE::IMC::SoiCommand::fieldsEqual ( const Message & other ) const

virtual

Compare fields for equality.

Parameters

[in] other message to compare.

Returns: true if fields are equal, false otherwise.

Reimplemented from DUNE::IMC::Message.

References command, info, plan, settings, and type.

void DUNE::IMC::SoiCommand::fieldsToJSON	(	std::ostream &	os,
		unsigned	indent_level
	)		const

virtual

Output the message fields (excluding header) in JSON format.

Parameters

os	output stream.
indent_level	number of indentation spaces.

Reimplemented from DUNE::IMC::Message.

References command, info, plan, settings, DUNE::IMC::toJSON(), and type.

unsigned DUNE::IMC::SoiCommand::getFixedSerializationSize ( void ) const

inlinevirtual

Get the fixed amount of bytes required to properly serialize this message (variable length fields are not included).

Returns: amount of variable bytes required to serialize the message.

Reimplemented from DUNE::IMC::Message.

uint16_t DUNE::IMC::SoiCommand::getId ( void ) const

inlinevirtual

Retrieve message's identification number.

Returns: message's identification number.

Implements DUNE::IMC::Message.

References getIdStatic().

static uint16_t DUNE::IMC::SoiCommand::getIdStatic ( void )

inlinestatic

Referenced by getId().

const char* DUNE::IMC::SoiCommand::getName ( void ) const

inlinevirtual

Retrieve message's name.

Returns: message's name.

Implements DUNE::IMC::Message.

unsigned DUNE::IMC::SoiCommand::getVariableSerializationSize ( void ) const

inlinevirtual

Get the variable amount of bytes required to properly serialize this message (only the variable fields are included).

Returns: amount of variable bytes required to serialize the message.

Reimplemented from DUNE::IMC::Message.

References DUNE::IMC::getSerializationSize(), info, plan, and settings.

uint16_t DUNE::IMC::SoiCommand::reverseDeserializeFields	(	const uint8_t *	bfr,
		uint16_t	len
	)

virtual

Deserialize message fields from a packet, swapping the byte order.

Parameters

bfr	stream of bytes (packet)
len	length of the byte stream.

Returns: number of bytes processed.

Implements DUNE::IMC::Message.

References command, DUNE::IMC::deserialize(), info, plan, DUNE::IMC::reverseDeserialize(), settings, and type.

uint8_t * DUNE::IMC::SoiCommand::serializeFields ( uint8_t * bfr__ ) const

virtual

Implements DUNE::IMC::Message.

References command, info, plan, DUNE::IMC::serialize(), settings, and type.

void DUNE::IMC::SoiCommand::setDestinationEntityNested ( uint8_t value )

protectedvirtual

Set the destination entity of nested messages.

Parameters

[in] value destination entity.

Reimplemented from DUNE::IMC::Message.

References plan.

void DUNE::IMC::SoiCommand::setDestinationNested ( uint16_t value )

protectedvirtual

Set the destination address of nested messages.

Parameters

[in] value destination address.

Reimplemented from DUNE::IMC::Message.

References plan.

void DUNE::IMC::SoiCommand::setSourceEntityNested ( uint8_t value )

protectedvirtual

Set the source entity of nested messages.

Parameters

[in] value source entity.

Reimplemented from DUNE::IMC::Message.

References plan.

void DUNE::IMC::SoiCommand::setSourceNested ( uint16_t value )

protectedvirtual

Set the source address of nested messages.

Parameters

[in] value source address.

Reimplemented from DUNE::IMC::Message.

References plan.

void DUNE::IMC::SoiCommand::setTimeStampNested ( double value )

protectedvirtual

Set the timestamp of nested messages.

Parameters

[in] value timestamp.

Reimplemented from DUNE::IMC::Message.

References plan.

int DUNE::IMC::SoiCommand::validate ( void ) const

virtual

Validate the message's contents.

Returns: negative value in case of a valid message or a positive value indicating the position of the invalid message field.

Implements DUNE::IMC::Message.

Member Data Documentation

uint8_t DUNE::IMC::SoiCommand::command

Command.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

std::string DUNE::IMC::SoiCommand::info

Extra Information.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), getVariableSerializationSize(), reverseDeserializeFields(), and serializeFields().

InlineMessage<SoiPlan> DUNE::IMC::SoiCommand::plan

Plan.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), getVariableSerializationSize(), reverseDeserializeFields(), serializeFields(), setDestinationEntityNested(), setDestinationNested(), setSourceEntityNested(), setSourceNested(), setTimeStampNested(), and SoiCommand().

std::string DUNE::IMC::SoiCommand::settings

Settings.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), getVariableSerializationSize(), reverseDeserializeFields(), and serializeFields().

uint8_t DUNE::IMC::SoiCommand::type

Type.

Referenced by clear(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

Collaboration diagram for DUNE::IMC::SoiCommand:

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation