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

Detailed Description

Telemetry Message.

Public Types

enum  TypeEnum { TM_TX, TM_RX, TM_TXSTATUS }
 
enum  CodeEnum { TM_CODE_UNK, TM_CODE_REPORT, TM_CODE_IMC, TM_CODE_RAW }
 
enum  StatusEnum {
  TM_NONE, TM_DONE, TM_FAILED, TM_QUEUED,
  TM_TRANSMIT, TM_EXPIRED, TM_EMPTY, TM_INV_ADDR,
  TM_INV_SIZE
}
 
enum  AcknowledgeBits { TM_NAK, TM_AK }
 

Public Member Functions

 TelemetryMsg (void)
 
TelemetryMsg * 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 type
 
uint32_t req_id
 
uint16_t ttl
 
uint8_t code
 
std::string destination
 
std::string source
 
uint8_t acknowledge
 
uint8_t status
 
std::vector< char > data
 

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::TelemetryMsg::AcknowledgeBits

Acknowledge.

Enumerator
TM_NAK 

Not acknowledge.

TM_AK 

acknowledge.

enum DUNE::IMC::TelemetryMsg::CodeEnum

Code.

Enumerator
TM_CODE_UNK 

Code unknown.

TM_CODE_REPORT 

Code Report.

TM_CODE_IMC 

Code IMC.

TM_CODE_RAW 

Code raw.

enum DUNE::IMC::TelemetryMsg::StatusEnum

Status.

Enumerator
TM_NONE 

Does not apply.

TM_DONE 

Successfull transmission.

TM_FAILED 

Error while trying to transmit message.

TM_QUEUED 

Message has been queued for transmission.

TM_TRANSMIT 

Message is currently being transmitted.

TM_EXPIRED 

Message's TTL has expired. Transmition cancelled.

TM_EMPTY 

No more messages to be transmitted or received.

TM_INV_ADDR 

Invalid address.

TM_INV_SIZE 

Invalid transmission size.

enum DUNE::IMC::TelemetryMsg::TypeEnum

Type.

Enumerator
TM_TX 

Tx.

TM_RX 

Rx.

TM_TXSTATUS 

TxStatus.

Constructor & Destructor Documentation

DUNE::IMC::TelemetryMsg::TelemetryMsg ( void  )

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

Referenced by clone().

Member Function Documentation

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

Reset message's fields.

Implements DUNE::IMC::Message.

References acknowledge, code, data, destination, req_id, source, status, ttl, and type.

Referenced by TelemetryMsg().

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

Retrieve a copy of the message.

Returns
message copy.

Implements DUNE::IMC::Message.

References TelemetryMsg().

uint16_t DUNE::IMC::TelemetryMsg::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 acknowledge, code, data, DUNE::IMC::deserialize(), destination, req_id, source, status, ttl, and type.

bool DUNE::IMC::TelemetryMsg::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 acknowledge, code, data, destination, req_id, source, status, ttl, and type.

void DUNE::IMC::TelemetryMsg::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 acknowledge, code, data, destination, req_id, source, status, DUNE::IMC::toJSON(), ttl, and type.

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

Referenced by getId().

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

Retrieve message's name.

Returns
message's name.

Implements DUNE::IMC::Message.

unsigned DUNE::IMC::TelemetryMsg::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 data, destination, DUNE::IMC::getSerializationSize(), and source.

uint16_t DUNE::IMC::TelemetryMsg::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 acknowledge, code, data, DUNE::IMC::deserialize(), destination, req_id, DUNE::IMC::reverseDeserialize(), source, status, ttl, and type.

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

Implements DUNE::IMC::Message.

References acknowledge, code, data, destination, req_id, DUNE::IMC::serialize(), source, status, ttl, and type.

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

Acknowledge.

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

uint8_t DUNE::IMC::TelemetryMsg::code

Code.

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

std::vector<char> DUNE::IMC::TelemetryMsg::data

Data.

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

std::string DUNE::IMC::TelemetryMsg::destination

Destination Identifier.

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

uint32_t DUNE::IMC::TelemetryMsg::req_id

Request Identifier.

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

std::string DUNE::IMC::TelemetryMsg::source

Source Identifier.

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

uint8_t DUNE::IMC::TelemetryMsg::status

Status.

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

uint16_t DUNE::IMC::TelemetryMsg::ttl

Time to live.

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

uint8_t DUNE::IMC::TelemetryMsg::type

Type.

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

Collaboration diagram for DUNE::IMC::TelemetryMsg:
Collaboration graph