Detailed Description

The raw data for a RDM message and its associated timing information.

A RDMFrame holds the raw data and timing metadata for a RDM message. If no timing data was available, the timing values will be 0.

RDMFrames include the RDM Start Code (0xCC).

Collaboration diagram for ola::rdm::RDMFrame:

Classes
struct	Options

Public Member Functions
	RDMFrame (const uint8_t *data, unsigned int length, const Options &options=Options())
	Create an RDMFrame from a uint8_t pointer.
	RDMFrame (const ola::io::ByteString &data, const Options &options=Options())
	Create a RDMFrame using a ByteString. string.
bool	operator== (const RDMFrame &other) const
	Test for equality.

Public Attributes
ola::io::ByteString	data
	The raw RDM data, including the RDM start code.
struct {
uint32_t response_time
	The time between the end of the last byte of the request to the start of the response.
uint32_t break_time
	The duration of the break.
uint32_t mark_time
	The duration of the mark-after-break.
uint32_t data_time
	The time between the first and last byte of the data.
}	timing
	The timing measurements for an RDM Frame.

Constructor & Destructor Documentation

Create an RDMFrame from a uint8_t pointer.

Parameters

data	A pointer to the frame data, the contents are copied.
length	The size of the frame data.
options	Options used when creating the RDMFrame.

explicit

Create a RDMFrame using a ByteString. string.

Parameters

data	The ByteString with the RDM frame data.
options	Options used when creating the RDMFrame.

bool ola::rdm::RDMFrame::operator== ( const RDMFrame & other ) const

Test for equality.

Parameters

other The RDMFrame to test against.

struct { ... } ola::rdm::RDMFrame::timing

The timing measurements for an RDM Frame.

All times are measured in nanoseconds.

For DUB responses, the break and mark values will be 0.

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