DUNE: Uniform Navigational Environment  2017.01.0
DUNE::IMC::UamTxStatus Class Reference

Detailed Description

Public Types

enum  ValueEnum {
  UTS_DONE, UTS_FAILED, UTS_CANCELED, UTS_BUSY,
  UTS_INV_ADDR, UTS_IP, UTS_UNSUPPORTED, UTS_INV_SIZE
}
 

Public Member Functions

 UamTxStatus (void)
 
UamTxStatusclone (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
 
fp64_t getValueFP (void) const
 
void setValueFP (fp64_t val)
 
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)
 
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 seq
 
uint8_t value
 
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

Value.

Enumerator
UTS_DONE 

Transmission Completed.

UTS_FAILED 

Transmission Failed.

UTS_CANCELED 

Transmission Canceled.

UTS_BUSY 

Modem is busy.

UTS_INV_ADDR 

Invalid address.

UTS_IP 

In Progress.

UTS_UNSUPPORTED 

Unsupported operation.

UTS_INV_SIZE 

Invalid transmission size.

Constructor & Destructor Documentation

DUNE::IMC::UamTxStatus::UamTxStatus ( void  )

Member Function Documentation

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

Reset message's fields.

Implements DUNE::IMC::Message.

References error, seq, and value.

Referenced by UamTxStatus().

UamTxStatus* DUNE::IMC::UamTxStatus::clone ( void  ) const
inlinevirtual

Retrieve a copy of the message.

Returns
message copy.

Implements DUNE::IMC::Message.

References UamTxStatus().

uint16_t DUNE::IMC::UamTxStatus::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(), error, seq, and value.

bool DUNE::IMC::UamTxStatus::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, seq, and value.

void DUNE::IMC::UamTxStatus::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 error, seq, DUNE::IMC::toJSON(), and value.

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

Referenced by getId().

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

Retrieve message's name.

Returns
message's name.

Implements DUNE::IMC::Message.

fp64_t DUNE::IMC::UamTxStatus::getValueFP ( void  ) const
virtual

Get the field 'value' on messages containing a field with such an abbreviation with floating point type.

Returns
value of field 'value', 0.0 otherwise.

Reimplemented from DUNE::IMC::Message.

References value.

unsigned DUNE::IMC::UamTxStatus::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 error, and DUNE::IMC::getSerializationSize().

uint16_t DUNE::IMC::UamTxStatus::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(), error, DUNE::IMC::reverseDeserialize(), seq, and value.

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

Implements DUNE::IMC::Message.

References error, seq, DUNE::IMC::serialize(), and value.

void DUNE::IMC::UamTxStatus::setValueFP ( fp64_t  val)
virtual

Set the field 'value' on messages containing a field with such an abbreviation with floating point type.

Parameters
valdesired value.

Reimplemented from DUNE::IMC::Message.

References value.

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

uint16_t DUNE::IMC::UamTxStatus::seq
uint8_t DUNE::IMC::UamTxStatus::value
Collaboration diagram for DUNE::IMC::UamTxStatus:
Collaboration graph