Detailed Description

Tachograph.

Public Member Functions
	Tachograph (void)

Tachograph *	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

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

virtual unsigned	getVariableSerializationSize (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
fp64_t	timestamp_last_service

fp32_t	time_next_service

fp32_t	time_motor_next_service

fp32_t	time_idle_ground

fp32_t	time_idle_air

fp32_t	time_idle_water

fp32_t	time_idle_underwater

fp32_t	time_idle_unknown

fp32_t	time_motor_ground

fp32_t	time_motor_air

fp32_t	time_motor_water

fp32_t	time_motor_underwater

fp32_t	time_motor_unknown

int16_t	rpm_min

int16_t	rpm_max

fp32_t	depth_max

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

Constructor & Destructor Documentation

DUNE::IMC::Tachograph::Tachograph ( void )

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

Member Function Documentation

void DUNE::IMC::Tachograph::clear ( void )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

Tachograph* DUNE::IMC::Tachograph::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().

uint16_t DUNE::IMC::Tachograph::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().

bool DUNE::IMC::Tachograph::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 depth_max, rpm_max, rpm_min, time_idle_air, time_idle_ground, time_idle_underwater, time_idle_unknown, time_idle_water, time_motor_air, time_motor_ground, time_motor_next_service, time_motor_underwater, time_motor_unknown, time_motor_water, time_next_service, and timestamp_last_service.

void DUNE::IMC::Tachograph::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::toJSON().

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

References DUNE::IMC::EntityState::fieldsToJSON().

uint16_t DUNE::IMC::Tachograph::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::Tachograph::getIdStatic ( void )

inlinestatic

Referenced by getId().

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

inlinevirtual

Retrieve message's name.

Returns: message's name.

Implements DUNE::IMC::Message.

uint16_t DUNE::IMC::Tachograph::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::reverseDeserialize().

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

virtual

Implements DUNE::IMC::Message.

References DUNE::IMC::serialize().

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

fp32_t DUNE::IMC::Tachograph::depth_max

Recorded Depth - Maximum.

Referenced by fieldsEqual().

int16_t DUNE::IMC::Tachograph::rpm_max

Recorded RPMs - Maximum.

Referenced by fieldsEqual().

int16_t DUNE::IMC::Tachograph::rpm_min

Recorded RPMs - Minimum.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_idle_air

Time Idle - Air.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_idle_ground

Time Idle - Ground.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_idle_underwater

Time Idle - Underwater.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_idle_unknown

Time Idle - Unknown.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_idle_water

Time Idle - Water.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_motor_air

Time Motor - Air.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_motor_ground

Time Motor - Ground.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_motor_next_service

Time Motor - Next Service.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_motor_underwater

Time Motor - Underwater.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_motor_unknown

Time Motor - Unknown.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_motor_water

Time Motor - Water.

Referenced by fieldsEqual().

fp32_t DUNE::IMC::Tachograph::time_next_service

Time - Next Service.

Referenced by fieldsEqual().

fp64_t DUNE::IMC::Tachograph::timestamp_last_service

Last Service Timestamp.

Referenced by fieldsEqual().

Collaboration diagram for DUNE::IMC::Tachograph:

Detailed Description

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation