Detailed Description

Vehicle Operational Limits.

Public Types
enum	ActiononthevehicleoperationallimitsEnum { OP_REQUEST, OP_SET, OP_REPORT }

Public Member Functions
	VehicleOperationalLimits (void)

VehicleOperationalLimits *	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
uint8_t	op

fp32_t	speed_min

fp32_t	speed_max

fp32_t	long_accel

fp32_t	alt_max_msl

fp32_t	dive_fraction_max

fp32_t	climb_fraction_max

fp32_t	bank_max

fp32_t	p_max

fp32_t	pitch_min

fp32_t	pitch_max

fp32_t	q_max

fp32_t	g_min

fp32_t	g_max

fp32_t	g_lat_max

fp32_t	rpm_min

fp32_t	rpm_max

fp32_t	rpm_rate_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

Member Enumeration Documentation

enum DUNE::IMC::VehicleOperationalLimits::ActiononthevehicleoperationallimitsEnum

Action on the vehicle operational limits.

Enumerator
OP_REQUEST	Request.
OP_SET	Set.
OP_REPORT	Report.

Constructor & Destructor Documentation

DUNE::IMC::VehicleOperationalLimits::VehicleOperationalLimits ( void )

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

Referenced by clone().

Member Function Documentation

void DUNE::IMC::VehicleOperationalLimits::clear ( void )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References alt_max_msl, bank_max, climb_fraction_max, dive_fraction_max, g_lat_max, g_max, g_min, long_accel, op, p_max, pitch_max, pitch_min, q_max, rpm_max, rpm_min, rpm_rate_max, speed_max, and speed_min.

Referenced by VehicleOperationalLimits().

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

inlinevirtual

Retrieve a copy of the message.

Returns: message copy.

Implements DUNE::IMC::Message.

References VehicleOperationalLimits().

uint16_t DUNE::IMC::VehicleOperationalLimits::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 alt_max_msl, bank_max, climb_fraction_max, DUNE::IMC::deserialize(), dive_fraction_max, g_lat_max, g_max, g_min, long_accel, op, p_max, pitch_max, pitch_min, q_max, rpm_max, rpm_min, rpm_rate_max, speed_max, and speed_min.

bool DUNE::IMC::VehicleOperationalLimits::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 alt_max_msl, bank_max, climb_fraction_max, dive_fraction_max, g_lat_max, g_max, g_min, long_accel, op, p_max, pitch_max, pitch_min, q_max, rpm_max, rpm_min, rpm_rate_max, speed_max, and speed_min.

void DUNE::IMC::VehicleOperationalLimits::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 alt_max_msl, bank_max, climb_fraction_max, dive_fraction_max, g_lat_max, g_max, g_min, long_accel, op, p_max, pitch_max, pitch_min, q_max, rpm_max, rpm_min, rpm_rate_max, speed_max, speed_min, and DUNE::IMC::toJSON().

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

inlinestatic

Referenced by getId().

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

inlinevirtual

Retrieve message's name.

Returns: message's name.

Implements DUNE::IMC::Message.

uint16_t DUNE::IMC::VehicleOperationalLimits::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 alt_max_msl, bank_max, climb_fraction_max, DUNE::IMC::deserialize(), dive_fraction_max, g_lat_max, g_max, g_min, long_accel, op, p_max, pitch_max, pitch_min, q_max, DUNE::IMC::reverseDeserialize(), rpm_max, rpm_min, rpm_rate_max, speed_max, and speed_min.

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

virtual

Implements DUNE::IMC::Message.

References alt_max_msl, bank_max, climb_fraction_max, dive_fraction_max, g_lat_max, g_max, g_min, long_accel, op, p_max, pitch_max, pitch_min, q_max, rpm_max, rpm_min, rpm_rate_max, DUNE::IMC::serialize(), speed_max, and speed_min.

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

References alt_max_msl, bank_max, climb_fraction_max, dive_fraction_max, g_lat_max, g_max, g_min, long_accel, p_max, q_max, rpm_max, rpm_min, rpm_rate_max, speed_max, and speed_min.

Member Data Documentation

fp32_t DUNE::IMC::VehicleOperationalLimits::alt_max_msl

Maximum MSL altitude.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::bank_max

Bank limit.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::climb_fraction_max

Maximum Climb Rate Speed Fraction.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::dive_fraction_max

Maximum Dive Rate Speed Fraction.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::g_lat_max

Maximum lateral load factor.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::g_max

Maximum load factor.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::g_min

Minimum load factor.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::long_accel

Longitudinal maximum acceleration.

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

uint8_t DUNE::IMC::VehicleOperationalLimits::op

Action on the vehicle operational limits.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::p_max

Bank rate limit.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::pitch_max

Maximum pitch angle.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::pitch_min

Minimum pitch angle.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::q_max

Maximum pitch rate.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::rpm_max

Maximum RPMs.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::rpm_min

Minimum RPMs.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::rpm_rate_max

Maximum RPM rate.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::speed_max

Maximum speed.

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

fp32_t DUNE::IMC::VehicleOperationalLimits::speed_min

Minimum speed.

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

Collaboration diagram for DUNE::IMC::VehicleOperationalLimits:

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