Detailed Description

Vehicle State.

Public Types
enum	OperationModeEnum { VS_SERVICE, VS_CALIBRATION, VS_ERROR, VS_MANEUVER, VS_EXTERNAL, VS_BOOT }

enum	FlagsBits { VFLG_MANEUVER_DONE }

Public Member Functions
	VehicleState (void)

VehicleState *	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	op_mode

uint8_t	error_count

std::string	error_ents

uint16_t	maneuver_type

fp64_t	maneuver_stime

uint16_t	maneuver_eta

uint32_t	control_loops

uint8_t	flags

std::string	last_error

fp64_t	last_error_time

Additional Inherited Members
Protected Member Functions inherited from DUNE::IMC::Message
virtual void	setTimeStampNested (double value)

virtual void	setSourceNested (uint16_t value)

virtual void	setSourceEntityNested (uint8_t value)

virtual void	setDestinationNested (uint16_t value)

virtual void	setDestinationEntityNested (uint8_t value)

Protected Attributes inherited from DUNE::IMC::Message
Header	m_header

Member Enumeration Documentation

◆ FlagsBits

enum DUNE::IMC::VehicleState::FlagsBits

Flags.

Enumerator
VFLG_MANEUVER_DONE	Maneuver Done.

◆ OperationModeEnum

enum DUNE::IMC::VehicleState::OperationModeEnum

Operation Mode.

Enumerator
VS_SERVICE	Service.
VS_CALIBRATION	Calibration.
VS_ERROR	Error.
VS_MANEUVER	Maneuver.
VS_EXTERNAL	External Control.
VS_BOOT	Boot.

Constructor & Destructor Documentation

◆ VehicleState()

DUNE::IMC::VehicleState::VehicleState ( void )

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

Member Function Documentation

◆ clear()

void DUNE::IMC::VehicleState::clear ( void )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References DUNE::IMC::EntityState::flags.

◆ clone()

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

inlinevirtual

Retrieve a copy of the message.

Returns: message copy.

Implements DUNE::IMC::Message.

References DUNE::IMC::EntityState::clear(), DUNE::IMC::EntityState::deserializeFields(), DUNE::IMC::EntityState::fieldsEqual(), DUNE::IMC::EntityState::reverseDeserializeFields(), DUNE::IMC::EntityState::serializeFields(), and DUNE::IMC::EntityState::validate().

◆ deserializeFields()

uint16_t DUNE::IMC::VehicleState::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 DUNE::IMC::deserialize(), and DUNE::IMC::EntityState::flags.

◆ fieldsEqual()

bool DUNE::IMC::VehicleState::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 control_loops, error_count, error_ents, DUNE::IMC::EntityState::flags, flags, last_error, last_error_time, maneuver_eta, maneuver_stime, maneuver_type, and op_mode.

◆ fieldsToJSON()

void DUNE::IMC::VehicleState::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 DUNE::IMC::EntityState::flags, and DUNE::IMC::toJSON().

◆ getFixedSerializationSize()

unsigned DUNE::IMC::VehicleState::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.

◆ getId()

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

inlinevirtual

Retrieve message's identification number.

Returns: message's identification number.

Implements DUNE::IMC::Message.

References getIdStatic().

◆ getIdStatic()

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

inlinestatic

Referenced by getId().

◆ getName()

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

inlinevirtual

Retrieve message's name.

Returns: message's name.

Implements DUNE::IMC::Message.

◆ getVariableSerializationSize()

unsigned DUNE::IMC::VehicleState::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::EntityState::fieldsToJSON(), and DUNE::IMC::getSerializationSize().

◆ reverseDeserializeFields()

uint16_t DUNE::IMC::VehicleState::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 DUNE::IMC::deserialize(), DUNE::IMC::EntityState::flags, and DUNE::IMC::reverseDeserialize().

◆ serializeFields()

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

virtual

Implements DUNE::IMC::Message.

References DUNE::IMC::EntityState::flags, and DUNE::IMC::serialize().

◆ validate()

int DUNE::IMC::VehicleState::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

◆ control_loops

uint32_t DUNE::IMC::VehicleState::control_loops

Control Loops.

Referenced by fieldsEqual().

◆ error_count

uint8_t DUNE::IMC::VehicleState::error_count

Errors – Count.

Referenced by fieldsEqual().

◆ error_ents

std::string DUNE::IMC::VehicleState::error_ents

Errors – Entities.

Referenced by fieldsEqual().

◆ flags

uint8_t DUNE::IMC::VehicleState::flags

Flags.

Referenced by fieldsEqual().

◆ last_error

std::string DUNE::IMC::VehicleState::last_error

Last Error – Description.

Referenced by fieldsEqual().

◆ last_error_time

fp64_t DUNE::IMC::VehicleState::last_error_time

Last Error – Time.

Referenced by fieldsEqual().

◆ maneuver_eta

uint16_t DUNE::IMC::VehicleState::maneuver_eta

Maneuver – ETA.

Referenced by fieldsEqual().

◆ maneuver_stime

fp64_t DUNE::IMC::VehicleState::maneuver_stime

Maneuver – Start Time.

Referenced by fieldsEqual().

◆ maneuver_type

uint16_t DUNE::IMC::VehicleState::maneuver_type

Maneuver – Type.

Referenced by fieldsEqual().

◆ op_mode

uint8_t DUNE::IMC::VehicleState::op_mode

Operation Mode.

Referenced by fieldsEqual().

Collaboration diagram for DUNE::IMC::VehicleState:

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ FlagsBits

◆ OperationModeEnum

Constructor & Destructor Documentation

◆ VehicleState()

Member Function Documentation

◆ clear()

◆ clone()

◆ deserializeFields()

◆ fieldsEqual()

◆ fieldsToJSON()

◆ getFixedSerializationSize()

◆ getId()

◆ getIdStatic()

◆ getName()

◆ getVariableSerializationSize()

◆ reverseDeserializeFields()

◆ serializeFields()

◆ validate()

Member Data Documentation

◆ control_loops

◆ error_count

◆ error_ents

◆ flags

◆ last_error

◆ last_error_time

◆ maneuver_eta

◆ maneuver_stime

◆ maneuver_type

◆ op_mode