Detailed Description

Compass Calibration Maneuver.

Public Types
enum	DirectionEnum { LD_VDEP, LD_CLOCKW, LD_CCLOCKW, LD_IWINDCURR }

Public Member Functions
	CompassCalibration (void)

CompassCalibration *	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
uint16_t	timeout

fp64_t	lat

fp64_t	lon

fp32_t	z

uint8_t	z_units

fp32_t	pitch

fp32_t	amplitude

uint16_t	duration

fp32_t	speed

uint8_t	speed_units

fp32_t	radius

uint8_t	direction

std::string	custom

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

◆ DirectionEnum

enum DUNE::IMC::CompassCalibration::DirectionEnum

Direction.

Enumerator
LD_VDEP	Vehicle Dependent.
LD_CLOCKW	Clockwise.
LD_CCLOCKW	Counter Clockwise.
LD_IWINDCURR	Into the wind/current.

Constructor & Destructor Documentation

◆ CompassCalibration()

DUNE::IMC::CompassCalibration::CompassCalibration ( void )

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

Member Function Documentation

◆ clear()

void DUNE::IMC::CompassCalibration::clear ( void )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

◆ clone()

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

◆ fieldsEqual()

bool DUNE::IMC::CompassCalibration::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 amplitude, custom, direction, duration, lat, lon, pitch, radius, speed, speed_units, timeout, z, and z_units.

◆ fieldsToJSON()

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

◆ getFixedSerializationSize()

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

inlinestatic

Referenced by getId().

◆ getName()

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

inlinevirtual

Retrieve message's name.

Returns: message's name.

Implements DUNE::IMC::Message.

◆ getVariableSerializationSize()

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

◆ serializeFields()

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

virtual

Implements DUNE::IMC::Message.

References DUNE::IMC::serialize().

◆ validate()

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

◆ amplitude

fp32_t DUNE::IMC::CompassCalibration::amplitude

Amplitude.

Referenced by fieldsEqual(), and DUNE::Parsers::PlanConfigParser::parse().

◆ custom

std::string DUNE::IMC::CompassCalibration::custom

Custom settings for maneuver.

Referenced by fieldsEqual().

◆ direction

uint8_t DUNE::IMC::CompassCalibration::direction

Direction.

Referenced by fieldsEqual(), and DUNE::Parsers::PlanConfigParser::parse().

◆ duration

uint16_t DUNE::IMC::CompassCalibration::duration

Duration.

Referenced by fieldsEqual(), and DUNE::Plans::TimeProfile::isDurationFinite().

◆ lat

fp64_t DUNE::IMC::CompassCalibration::lat

Latitude WGS-84.

Referenced by fieldsEqual().

◆ lon

fp64_t DUNE::IMC::CompassCalibration::lon

Longitude WGS-84.

Referenced by fieldsEqual().

◆ pitch

fp32_t DUNE::IMC::CompassCalibration::pitch

Pitch.

Referenced by fieldsEqual(), and DUNE::Parsers::PlanConfigParser::parse().

◆ radius

fp32_t DUNE::IMC::CompassCalibration::radius

Radius.

Referenced by fieldsEqual(), and DUNE::Parsers::PlanConfigParser::parse().

◆ speed

fp32_t DUNE::IMC::CompassCalibration::speed

Speed.

Referenced by fieldsEqual().

◆ speed_units

uint8_t DUNE::IMC::CompassCalibration::speed_units

Speed Units.

Referenced by fieldsEqual().

◆ timeout

uint16_t DUNE::IMC::CompassCalibration::timeout

Timeout.

Referenced by fieldsEqual().

◆ z

fp32_t DUNE::IMC::CompassCalibration::z

Z Reference.

Referenced by fieldsEqual().

◆ z_units

uint8_t DUNE::IMC::CompassCalibration::z_units

Z Units.

Referenced by fieldsEqual().

Collaboration diagram for DUNE::IMC::CompassCalibration:

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ DirectionEnum

Constructor & Destructor Documentation

◆ CompassCalibration()

Member Function Documentation

◆ clear()

◆ clone()

◆ deserializeFields()

◆ fieldsEqual()

◆ fieldsToJSON()

◆ getFixedSerializationSize()

◆ getId()

◆ getIdStatic()

◆ getName()

◆ getVariableSerializationSize()

◆ reverseDeserializeFields()

◆ serializeFields()

◆ validate()

Member Data Documentation

◆ amplitude

◆ custom

◆ direction

◆ duration

◆ lat

◆ lon

◆ pitch

◆ radius

◆ speed

◆ speed_units

◆ timeout

◆ z

◆ z_units