DUNE: Uniform Navigational Environment  2020.01.0
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes
DUNE::IMC::EntityActivationState Class Reference

Detailed Description

Entity Activation State.

Public Types

Public Member Functions

 EntityActivationState (void)
 
EntityActivationState * 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 error
 

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::EntityActivationState::StateEnum

State.

Enumerator
EAS_INACTIVE 

Entity is Inactive.

EAS_ACTIVE 

Entity is Active.

EAS_ACT_IP 

Activation in Progress.

EAS_ACT_DONE 

Activation Completed.

EAS_ACT_FAIL 

Activation Failed.

EAS_DEACT_IP 

Deactivation In Progress.

EAS_DEACT_DONE 

Deactivation Completed.

EAS_DEACT_FAIL 

Deactivation Failed.

Constructor & Destructor Documentation

DUNE::IMC::EntityActivationState::EntityActivationState ( void  )

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

Member Function Documentation

void DUNE::IMC::EntityActivationState::clear ( void  )
virtual

Reset message's fields.

Implements DUNE::IMC::Message.

References DUNE::IMC::EntityState::state.

EntityActivationState* DUNE::IMC::EntityActivationState::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::EntityActivationState::deserializeFields ( const uint8_t *  bfr,
uint16_t  len 
)
virtual

Deserialize message fields from a packet.

Parameters
bfrstream of bytes (packet)
lenlength of the byte stream.
Returns
number of bytes processed.

Implements DUNE::IMC::Message.

References DUNE::IMC::deserialize(), and DUNE::IMC::EntityState::state.

bool DUNE::IMC::EntityActivationState::fieldsEqual ( const Message &  other) const
virtual

Compare fields for equality.

Parameters
[in]othermessage to compare.
Returns
true if fields are equal, false otherwise.

Reimplemented from DUNE::IMC::Message.

References error, DUNE::IMC::EntityState::state, and state.

void DUNE::IMC::EntityActivationState::fieldsToJSON ( std::ostream &  os,
unsigned  indent_level 
) const
virtual

Output the message fields (excluding header) in JSON format.

Parameters
osoutput stream.
indent_levelnumber of indentation spaces.

Reimplemented from DUNE::IMC::Message.

References DUNE::IMC::EntityState::state, and DUNE::IMC::toJSON().

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

Referenced by getId().

const char* DUNE::IMC::EntityActivationState::getName ( void  ) const
inlinevirtual

Retrieve message's name.

Returns
message's name.

Implements DUNE::IMC::Message.

unsigned DUNE::IMC::EntityActivationState::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().

uint16_t DUNE::IMC::EntityActivationState::reverseDeserializeFields ( const uint8_t *  bfr,
uint16_t  len 
)
virtual

Deserialize message fields from a packet, swapping the byte order.

Parameters
bfrstream of bytes (packet)
lenlength of the byte stream.
Returns
number of bytes processed.

Implements DUNE::IMC::Message.

References DUNE::IMC::deserialize(), DUNE::IMC::reverseDeserialize(), and DUNE::IMC::EntityState::state.

uint8_t * DUNE::IMC::EntityActivationState::serializeFields ( uint8_t *  bfr__) const
virtual

Implements DUNE::IMC::Message.

References DUNE::IMC::serialize(), and DUNE::IMC::EntityState::state.

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

std::string DUNE::IMC::EntityActivationState::error

Error.

Referenced by DUNE::Entities::StatefulEntity::failActivation(), DUNE::Entities::StatefulEntity::failDeactivation(), and fieldsEqual().

uint8_t DUNE::IMC::EntityActivationState::state

State.

Referenced by DUNE::Entities::StatefulEntity::failActivation(), DUNE::Entities::StatefulEntity::failDeactivation(), fieldsEqual(), DUNE::Entities::StatefulEntity::getActivationState(), DUNE::Entities::StatefulEntity::isActivating(), DUNE::Entities::StatefulEntity::isActive(), DUNE::Entities::StatefulEntity::isDeactivating(), DUNE::Entities::StatefulEntity::requestActivation(), DUNE::Entities::StatefulEntity::requestDeactivation(), DUNE::Entities::StatefulEntity::StatefulEntity(), DUNE::Entities::StatefulEntity::succeedActivation(), and DUNE::Entities::StatefulEntity::succeedDeactivation().

Collaboration diagram for DUNE::IMC::EntityActivationState:
Collaboration graph