DUNE::IMC::PlanControlState Class Reference

Detailed Description

Plan Control State.

Public Types
enum	StateEnum { PCS_BLOCKED, PCS_READY, PCS_INITIALIZING, PCS_EXECUTING }
enum	LastPlanOutcomeEnum { LPO_NONE, LPO_SUCCESS, LPO_FAILURE }

Public Member Functions
	PlanControlState (void)
Message *	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
uint8_t	state
std::string	plan_id
int32_t	plan_eta
fp32_t	plan_progress
std::string	man_id
uint16_t	man_type
int32_t	man_eta
uint8_t	last_outcome

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::PlanControlState::LastPlanOutcomeEnum

Last Plan Outcome.

Enumerator
LPO_NONE	None.
LPO_SUCCESS	Success.
LPO_FAILURE	Failure.

enum DUNE::IMC::PlanControlState::StateEnum

State.

Enumerator
PCS_BLOCKED	Blocked.
PCS_READY	Ready.
PCS_INITIALIZING	Initializing.
PCS_EXECUTING	Executing.

Constructor & Destructor Documentation

DUNE::IMC::PlanControlState::PlanControlState

(

void

)

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

Referenced by clone().

Member Function Documentation

void DUNE::IMC::PlanControlState::clear ( void  )

virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References last_outcome, man_eta, man_id, man_type, plan_eta, plan_id, plan_progress, and state.

Referenced by PlanControlState().

Message* DUNE::IMC::PlanControlState::clone ( void  ) const

inlinevirtual

Retrieve a copy of the message.

Returns

message copy.

Implements DUNE::IMC::Message.

References PlanControlState().

uint16_t DUNE::IMC::PlanControlState::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(), last_outcome, man_eta, man_id, man_type, plan_eta, plan_id, plan_progress, and state.

bool DUNE::IMC::PlanControlState::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 last_outcome, man_eta, man_id, man_type, plan_eta, plan_id, plan_progress, and state.

void DUNE::IMC::PlanControlState::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 last_outcome, man_eta, man_id, man_type, plan_eta, plan_id, plan_progress, state, and DUNE::IMC::toJSON().

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

inlinestatic

Referenced by getId().

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

inlinevirtual

Retrieve message's name.

Returns

message's name.

Implements DUNE::IMC::Message.

unsigned DUNE::IMC::PlanControlState::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(), man_id, and plan_id.

uint16_t DUNE::IMC::PlanControlState::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(), last_outcome, man_eta, man_id, man_type, plan_eta, plan_id, plan_progress, DUNE::IMC::reverseDeserialize(), and state.

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

virtual

Implements DUNE::IMC::Message.

References last_outcome, man_eta, man_id, man_type, plan_eta, plan_id, plan_progress, DUNE::IMC::serialize(), and state.

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

uint8_t DUNE::IMC::PlanControlState::last_outcome

Last Plan Outcome.

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

int32_t DUNE::IMC::PlanControlState::man_eta

Maneuver – ETA.

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

std::string DUNE::IMC::PlanControlState::man_id

Maneuver – ID.

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

uint16_t DUNE::IMC::PlanControlState::man_type

Maneuver – Type.

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

int32_t DUNE::IMC::PlanControlState::plan_eta

Plan – ETA.

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

std::string DUNE::IMC::PlanControlState::plan_id

Plan – ID.

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

fp32_t DUNE::IMC::PlanControlState::plan_progress

Plan – Progress.

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

uint8_t DUNE::IMC::PlanControlState::state

State.

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

Collaboration diagram for DUNE::IMC::PlanControlState: