Detailed Description

Leader State.

Public Types
enum	ActionontheleaderstateEnum { OP_REQUEST, OP_SET, OP_REPORT }

Public Member Functions
	LeaderState (void)

LeaderState *	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
std::string	group_name

uint8_t	op

fp64_t	lat

fp64_t	lon

fp32_t	height

fp32_t	x

fp32_t	y

fp32_t	z

fp32_t	phi

fp32_t	theta

fp32_t	psi

fp32_t	vx

fp32_t	vy

fp32_t	vz

fp32_t	p

fp32_t	q

fp32_t	r

fp32_t	svx

fp32_t	svy

fp32_t	svz

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

enum DUNE::IMC::LeaderState::ActionontheleaderstateEnum

Action on the leader state.

Enumerator
OP_REQUEST	Request.
OP_SET	Set.
OP_REPORT	Report.

Constructor & Destructor Documentation

DUNE::IMC::LeaderState::LeaderState ( void )

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

Referenced by clone().

Member Function Documentation

void DUNE::IMC::LeaderState::clear ( void )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References group_name, height, lat, lon, op, p, phi, psi, q, r, svx, svy, svz, theta, vx, vy, vz, x, y, and z.

Referenced by LeaderState().

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

inlinevirtual

Retrieve a copy of the message.

Returns: message copy.

Implements DUNE::IMC::Message.

References LeaderState().

uint16_t DUNE::IMC::LeaderState::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(), group_name, height, lat, lon, op, p, phi, psi, q, r, svx, svy, svz, theta, vx, vy, vz, x, y, and z.

bool DUNE::IMC::LeaderState::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 group_name, height, lat, lon, op, p, phi, psi, q, r, svx, svy, svz, theta, vx, vy, vz, x, y, and z.

void DUNE::IMC::LeaderState::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 group_name, height, lat, lon, op, p, phi, psi, q, r, svx, svy, svz, theta, DUNE::IMC::toJSON(), vx, vy, vz, x, y, and z.

unsigned DUNE::IMC::LeaderState::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::LeaderState::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::LeaderState::getIdStatic ( void )

inlinestatic

Referenced by getId().

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

inlinevirtual

Retrieve message's name.

Returns: message's name.

Implements DUNE::IMC::Message.

unsigned DUNE::IMC::LeaderState::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(), and group_name.

uint16_t DUNE::IMC::LeaderState::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(), group_name, height, lat, lon, op, p, phi, psi, q, r, DUNE::IMC::reverseDeserialize(), svx, svy, svz, theta, vx, vy, vz, x, y, and z.

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

virtual

Implements DUNE::IMC::Message.

References group_name, height, lat, lon, op, p, phi, psi, q, r, DUNE::IMC::serialize(), svx, svy, svz, theta, vx, vy, vz, x, y, and z.

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

std::string DUNE::IMC::LeaderState::group_name

Group Name.

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

fp32_t DUNE::IMC::LeaderState::height

Height (WGS-84).

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

fp64_t DUNE::IMC::LeaderState::lat

Latitude (WGS-84).

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

fp64_t DUNE::IMC::LeaderState::lon

Longitude (WGS-84).

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

uint8_t DUNE::IMC::LeaderState::op

Action on the leader state.

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

fp32_t DUNE::IMC::LeaderState::p

Angular Velocity in x.

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

fp32_t DUNE::IMC::LeaderState::phi

Rotation over x axis.

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

fp32_t DUNE::IMC::LeaderState::psi

Rotation over z axis.

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

fp32_t DUNE::IMC::LeaderState::q

Angular Velocity in y.

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

fp32_t DUNE::IMC::LeaderState::r

Angular Velocity in z.

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

fp32_t DUNE::IMC::LeaderState::svx

Stream Velocity X (North).

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

fp32_t DUNE::IMC::LeaderState::svy

Stream Velocity Y (East).

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

fp32_t DUNE::IMC::LeaderState::svz

Stream Velocity Z (Down).

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

fp32_t DUNE::IMC::LeaderState::theta

Rotation over y axis.

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

fp32_t DUNE::IMC::LeaderState::vx

Ground Velocity X (North).

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

fp32_t DUNE::IMC::LeaderState::vy

Ground Velocity Y (East).

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

fp32_t DUNE::IMC::LeaderState::vz

Ground Velocity Z (Down).

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

fp32_t DUNE::IMC::LeaderState::x

Offset north.

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

fp32_t DUNE::IMC::LeaderState::y

Offset east.

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

fp32_t DUNE::IMC::LeaderState::z

Offset down.

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

Collaboration diagram for DUNE::IMC::LeaderState:

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation