uavcan::Frame Class Reference

#include <frame.hpp>

Inheritance diagram for uavcan::Frame:

Public Member Functions
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_t *	getPayloadPtr () 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 Types
enum	{ PayloadCapacity = 7 }

Private Attributes
DataTypeID	data_type_id_
NodeID	dst_node_id_
bool	end_of_transfer_
uint8_t	payload_ [PayloadCapacity]
uint_fast8_t	payload_len_
NodeID	src_node_id_
bool	start_of_transfer_
bool	toggle_
TransferID	transfer_id_
TransferPriority	transfer_priority_
TransferType	transfer_type_

Detailed Description

Definition at line 17 of file frame.hpp.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
PayloadCapacity

Definition at line 19 of file frame.hpp.

Constructor & Destructor Documentation

Frame() [1/2]

uavcan::Frame::Frame ( )

inline

Definition at line 34 of file frame.hpp.

Frame() [2/2]

uavcan::Frame::Frame ( DataTypeID  data_type_id, TransferType  transfer_type, NodeID  src_node_id, NodeID  dst_node_id, TransferID  transfer_id  )

inline

Definition at line 42 of file frame.hpp.

Member Function Documentation

compile()

bool uavcan::Frame::compile

(

CanFrame &

can_frame

)

const

Definition at line 112 of file uc_frame.cpp.

flipToggle()

void uavcan::Frame::flipToggle ( )

inline

Definition at line 87 of file frame.hpp.

getDataTypeID()

DataTypeID uavcan::Frame::getDataTypeID ( ) const

inline

Definition at line 76 of file frame.hpp.

getDstNodeID()

NodeID uavcan::Frame::getDstNodeID ( ) const

inline

Definition at line 78 of file frame.hpp.

getPayloadCapacity()

uint8_t uavcan::Frame::getPayloadCapacity ( ) const

inline

Max payload length depends on the transfer type and frame index.

Definition at line 69 of file frame.hpp.

getPayloadLen()

unsigned uavcan::Frame::getPayloadLen ( ) const

inline

Definition at line 72 of file frame.hpp.

getPayloadPtr()

const uint8_t* uavcan::Frame::getPayloadPtr ( ) const

inline

Definition at line 73 of file frame.hpp.

getPriority()

TransferPriority uavcan::Frame::getPriority ( ) const

inline

Definition at line 64 of file frame.hpp.

getSrcNodeID()

NodeID uavcan::Frame::getSrcNodeID ( ) const

inline

Definition at line 77 of file frame.hpp.

getToggle()

bool uavcan::Frame::getToggle ( ) const

inline

Definition at line 88 of file frame.hpp.

getTransferID()

TransferID uavcan::Frame::getTransferID ( ) const

inline

Definition at line 79 of file frame.hpp.

getTransferType()

TransferType uavcan::Frame::getTransferType ( ) const

inline

Definition at line 75 of file frame.hpp.

isEndOfTransfer()

bool uavcan::Frame::isEndOfTransfer ( ) const

inline

Definition at line 85 of file frame.hpp.

isStartOfTransfer()

bool uavcan::Frame::isStartOfTransfer ( ) const

inline

Definition at line 84 of file frame.hpp.

isValid()

bool uavcan::Frame::isValid

(

)

const

Definition at line 181 of file uc_frame.cpp.

operator!=()

bool uavcan::Frame::operator!= ( const Frame &  rhs ) const

inline

Definition at line 95 of file frame.hpp.

operator==()

bool uavcan::Frame::operator==

(

const Frame &

rhs

)

const

Definition at line 260 of file uc_frame.cpp.

parse()

bool uavcan::Frame::parse

(

const CanFrame &

can_frame

)

Definition at line 34 of file uc_frame.cpp.

setEndOfTransfer()

void uavcan::Frame::setEndOfTransfer ( bool  x )

inline

Definition at line 82 of file frame.hpp.

setPayload()

uint8_t uavcan::Frame::setPayload	(	const uint8_t *	data,
		unsigned	len
	)

Frame

Definition at line 16 of file uc_frame.cpp.

setPriority()

void uavcan::Frame::setPriority ( TransferPriority  priority )

inline

Definition at line 63 of file frame.hpp.

setStartOfTransfer()

void uavcan::Frame::setStartOfTransfer ( bool  x )

inline

Definition at line 81 of file frame.hpp.

Member Data Documentation

data_type_id_

DataTypeID uavcan::Frame::data_type_id_

private

Definition at line 24 of file frame.hpp.

dst_node_id_

NodeID uavcan::Frame::dst_node_id_

private

Definition at line 27 of file frame.hpp.

end_of_transfer_

bool uavcan::Frame::end_of_transfer_

private

Definition at line 30 of file frame.hpp.

payload_

uint8_t uavcan::Frame::payload_[PayloadCapacity]

private

Definition at line 21 of file frame.hpp.

payload_len_

uint_fast8_t uavcan::Frame::payload_len_

private

Definition at line 25 of file frame.hpp.

src_node_id_

NodeID uavcan::Frame::src_node_id_

private

Definition at line 26 of file frame.hpp.

start_of_transfer_

bool uavcan::Frame::start_of_transfer_

private

Definition at line 29 of file frame.hpp.

toggle_

bool uavcan::Frame::toggle_

private

Definition at line 31 of file frame.hpp.

transfer_id_

TransferID uavcan::Frame::transfer_id_

private

Definition at line 28 of file frame.hpp.

transfer_priority_

TransferPriority uavcan::Frame::transfer_priority_

private

Definition at line 22 of file frame.hpp.

transfer_type_

TransferType uavcan::Frame::transfer_type_

private

Definition at line 23 of file frame.hpp.

---

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

• frame.hpp
• uc_frame.cpp