Detailed Description

GPS Fix.

Public Types
enum	TypeEnum { GFT_STANDALONE, GFT_DIFFERENTIAL, GFT_DEAD_RECKONING, GFT_MANUAL_INPUT, GFT_SIMULATION }

enum	ValidityBits { GFV_VALID_DATE, GFV_VALID_TIME, GFV_VALID_POS, GFV_VALID_COG, GFV_VALID_SOG, GFV_VALID_HACC, GFV_VALID_VACC, GFV_VALID_HDOP, GFV_VALID_VDOP }

Public Member Functions
	GpsFix (void)

GpsFix *	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
uint16_t	validity

uint8_t	type

uint16_t	utc_year

uint8_t	utc_month

uint8_t	utc_day

fp32_t	utc_time

fp64_t	lat

fp64_t	lon

fp32_t	height

uint8_t	satellites

fp32_t	cog

fp32_t	sog

fp32_t	hdop

fp32_t	vdop

fp32_t	hacc

fp32_t	vacc

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::GpsFix::TypeEnum

Type.

Enumerator
GFT_STANDALONE	Stand Alone.
GFT_DIFFERENTIAL	Differential.
GFT_DEAD_RECKONING	Dead Reckoning.
GFT_MANUAL_INPUT	Manual Input.
GFT_SIMULATION	Simulation.

enum DUNE::IMC::GpsFix::ValidityBits

Validity.

Enumerator
GFV_VALID_DATE	Valid Date.
GFV_VALID_TIME	Valid Time.
GFV_VALID_POS	Valid Position.
GFV_VALID_COG	Valid Course Over Ground.
GFV_VALID_SOG	Valid Speed Over Ground.
GFV_VALID_HACC	Valid Horizontal Accuracy Estimate.
GFV_VALID_VACC	Valid Vertical Accuracy Estimate.
GFV_VALID_HDOP	Valid Horizontal Dilution of Precision.
GFV_VALID_VDOP	Valid Vertical Dilution of Precision.

Constructor & Destructor Documentation

DUNE::IMC::GpsFix::GpsFix ( void )

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

Referenced by clone().

Member Function Documentation

void DUNE::IMC::GpsFix::clear ( void )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References cog, hacc, hdop, height, lat, lon, satellites, sog, type, utc_day, utc_month, utc_time, utc_year, vacc, validity, and vdop.

Referenced by GpsFix().

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

inlinevirtual

Retrieve a copy of the message.

Returns: message copy.

Implements DUNE::IMC::Message.

References GpsFix().

uint16_t DUNE::IMC::GpsFix::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 cog, DUNE::IMC::deserialize(), hacc, hdop, height, lat, lon, satellites, sog, type, utc_day, utc_month, utc_time, utc_year, vacc, validity, and vdop.

bool DUNE::IMC::GpsFix::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 cog, hacc, hdop, height, lat, lon, satellites, sog, type, utc_day, utc_month, utc_time, utc_year, vacc, validity, and vdop.

void DUNE::IMC::GpsFix::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 cog, hacc, hdop, height, lat, lon, satellites, sog, DUNE::IMC::toJSON(), type, utc_day, utc_month, utc_time, utc_year, vacc, validity, and vdop.

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

inlinestatic

Referenced by getId().

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

inlinevirtual

Retrieve message's name.

Returns: message's name.

Implements DUNE::IMC::Message.

uint16_t DUNE::IMC::GpsFix::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 cog, DUNE::IMC::deserialize(), hacc, hdop, height, lat, lon, DUNE::IMC::reverseDeserialize(), satellites, sog, type, utc_day, utc_month, utc_time, utc_year, vacc, validity, and vdop.

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

virtual

Implements DUNE::IMC::Message.

References cog, hacc, hdop, height, lat, lon, satellites, DUNE::IMC::serialize(), sog, type, utc_day, utc_month, utc_time, utc_year, vacc, validity, and vdop.

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

Course Over Ground.

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

fp32_t DUNE::IMC::GpsFix::hacc

Horizontal Accuracy Estimate.

Referenced by clear(), DUNE::Navigation::BasicNavigation::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

fp32_t DUNE::IMC::GpsFix::hdop

Horizontal Dilution of Precision.

Referenced by clear(), DUNE::Navigation::BasicNavigation::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

fp32_t DUNE::IMC::GpsFix::height

Height above WGS-84 ellipsoid.

Referenced by clear(), DUNE::Navigation::BasicNavigation::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), serializeFields(), DUNE::Navigation::BasicNavigation::setup(), and DUNE::Navigation::UsblTools::toFix().

fp64_t DUNE::IMC::GpsFix::lat

Latitude WGS-84.

Referenced by clear(), DUNE::Navigation::StreamEstimator::consume(), DUNE::Navigation::BasicNavigation::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), serializeFields(), DUNE::Navigation::BasicNavigation::setup(), DUNE::Navigation::UsblTools::toFix(), and DUNE::Navigation::BasicTransponder::update().

fp64_t DUNE::IMC::GpsFix::lon

Longitude WGS-84.

Referenced by clear(), DUNE::Navigation::StreamEstimator::consume(), DUNE::Navigation::BasicNavigation::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), serializeFields(), DUNE::Navigation::BasicNavigation::setup(), DUNE::Navigation::UsblTools::toFix(), and DUNE::Navigation::BasicTransponder::update().

uint8_t DUNE::IMC::GpsFix::satellites

Number of Satellites.

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

fp32_t DUNE::IMC::GpsFix::sog

Speed Over Ground.

Referenced by clear(), DUNE::Navigation::BasicNavigation::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

uint8_t DUNE::IMC::GpsFix::type

Type.

Referenced by clear(), DUNE::Navigation::BasicNavigation::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

uint8_t DUNE::IMC::GpsFix::utc_day

UTC Day.

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

uint8_t DUNE::IMC::GpsFix::utc_month

UTC Month.

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

fp32_t DUNE::IMC::GpsFix::utc_time

UTC Time of Fix.

Referenced by DUNE::Network::TDMA::check(), clear(), DUNE::Navigation::BasicNavigation::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

uint16_t DUNE::IMC::GpsFix::utc_year

UTC Year.

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

fp32_t DUNE::IMC::GpsFix::vacc

Vertical Accuracy Estimate.

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

uint16_t DUNE::IMC::GpsFix::validity

Validity.

Referenced by clear(), DUNE::Navigation::BasicNavigation::consume(), deserializeFields(), fieldsEqual(), fieldsToJSON(), reverseDeserializeFields(), and serializeFields().

fp32_t DUNE::IMC::GpsFix::vdop

Vertical Dilution of Precision.

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

Collaboration diagram for DUNE::IMC::GpsFix:

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