Public Member Functions | Private Attributes | List of all members
uavcan::RxFrame Class Reference

#include <frame.hpp>

Inheritance diagram for uavcan::RxFrame:
Inheritance graph
[legend]

Public Member Functions

uint8_t getIfaceIndex () const
 
MonotonicTime getMonotonicTimestamp () const
 
UtcTime getUtcTimestamp () const
 
bool parse (const CanRxFrame &can_frame)
 
 RxFrame ()
 
 RxFrame (const Frame &frame, MonotonicTime ts_mono, UtcTime ts_utc, uint8_t iface_index)
 
- Public Member Functions inherited from uavcan::Frame
bool compile (CanFrame &can_frame) const
 
void flipToggle ()
 
 Frame ()
 
 Frame (DataTypeID data_type_id, TransferType transfer_type, NodeID src_node_id, NodeID dst_node_id, TransferID transfer_id)
 
DataTypeID getDataTypeID () const
 
NodeID getDstNodeID () const
 
uint8_t getPayloadCapacity () const
 
unsigned getPayloadLen () const
 
const uint8_tgetPayloadPtr () const
 
TransferPriority getPriority () const
 
NodeID getSrcNodeID () const
 
bool getToggle () const
 
TransferID getTransferID () const
 
TransferType getTransferType () const
 
bool isEndOfTransfer () const
 
bool isStartOfTransfer () const
 
bool isValid () const
 
bool operator!= (const Frame &rhs) const
 
bool operator== (const Frame &rhs) const
 
bool parse (const CanFrame &can_frame)
 
void setEndOfTransfer (bool x)
 
uint8_t setPayload (const uint8_t *data, unsigned len)
 
void setPriority (TransferPriority priority)
 
void setStartOfTransfer (bool x)
 

Private Attributes

uint8_t iface_index_
 
MonotonicTime ts_mono_
 
UtcTime ts_utc_
 

Detailed Description

Definition at line 104 of file frame.hpp.

Constructor & Destructor Documentation

◆ RxFrame() [1/2]

uavcan::RxFrame::RxFrame ( )
inline

Definition at line 111 of file frame.hpp.

◆ RxFrame() [2/2]

uavcan::RxFrame::RxFrame ( const Frame frame,
MonotonicTime  ts_mono,
UtcTime  ts_utc,
uint8_t  iface_index 
)
inline

Definition at line 115 of file frame.hpp.

Member Function Documentation

◆ getIfaceIndex()

uint8_t uavcan::RxFrame::getIfaceIndex ( ) const
inline

Definition at line 135 of file frame.hpp.

◆ getMonotonicTimestamp()

MonotonicTime uavcan::RxFrame::getMonotonicTimestamp ( ) const
inline

Can't be zero.

Definition at line 128 of file frame.hpp.

◆ getUtcTimestamp()

UtcTime uavcan::RxFrame::getUtcTimestamp ( ) const
inline

Can be zero if not supported by the platform driver.

Definition at line 133 of file frame.hpp.

◆ parse()

bool uavcan::RxFrame::parse ( const CanRxFrame can_frame)

RxFrame

Definition at line 304 of file uc_frame.cpp.

Member Data Documentation

◆ iface_index_

uint8_t uavcan::RxFrame::iface_index_
private

Definition at line 108 of file frame.hpp.

◆ ts_mono_

MonotonicTime uavcan::RxFrame::ts_mono_
private

Definition at line 106 of file frame.hpp.

◆ ts_utc_

UtcTime uavcan::RxFrame::ts_utc_
private

Definition at line 107 of file frame.hpp.


The documentation for this class was generated from the following files:


uavcan_communicator
Author(s):
autogenerated on Fri Dec 13 2024 03:10:05