Open Lighting Architecture
0.10.4
|
An RDM Get / Set Request.
Public Member Functions | |
RDMGetSetRequest (const UID &source, const UID &destination, uint8_t transaction_number, uint8_t port_id, uint16_t sub_device, RDMCommandClass command_class, uint16_t param_id, const uint8_t *data, unsigned int length, const OverrideOptions &options) | |
Create a new Get / Set Request. More... | |
Public Member Functions inherited from ola::rdm::RDMRequest | |
RDMRequest (const UID &source, const UID &destination, uint8_t transaction_number, uint8_t port_id, uint16_t sub_device, RDMCommandClass command_class, uint16_t param_id, const uint8_t *data, unsigned int length, const OverrideOptions &options=OverrideOptions()) | |
Create a new request. More... | |
RDMCommandClass | CommandClass () const |
The CommmandClass of this message. | |
uint8_t | PortId () const |
The Port ID for this request. More... | |
virtual RDMRequest * | Duplicate () const |
Make a copy of the request. More... | |
virtual void | Print (CommandPrinter *printer, bool summarize, bool unpack_param_data) const |
Output the contents of the command to a CommandPrinter. More... | |
bool | IsDUB () const |
Check if this is a DUB request. More... | |
uint8_t | SubStartCode () const |
The Sub-Start code for the RDMCommand. | |
uint8_t | MessageLength () const |
The Message length field. | |
uint16_t | Checksum (uint16_t checksum) const |
Modify the calculated checksum for this command. More... | |
void | SetSourceUID (const UID &source_uid) |
Set the source UID. More... | |
void | SetTransactionNumber (uint8_t transaction_number) |
Set the transaction number. More... | |
void | SetPortId (uint8_t port_id) |
Set the Port Id. More... | |
Public Member Functions inherited from ola::rdm::RDMCommand | |
bool | operator== (const RDMCommand &other) const |
Test for equality. More... | |
const UID & | SourceUID () const |
Returns the Source UID of the RDMCommand. | |
const UID & | DestinationUID () const |
Returns the Destination UID of the RDMCommand. | |
uint8_t | TransactionNumber () const |
Returns the Transaction Number of the RDMCommand. | |
uint8_t | PortIdResponseType () const |
Returns the Port ID of the RDMCommand. | |
uint8_t | MessageCount () const |
Returns the Message Count of the RDMCommand. | |
uint16_t | SubDevice () const |
Returns the SubDevice of the RDMCommand. | |
uint16_t | ParamId () const |
Returns the Parameter ID of the RDMCommand. | |
unsigned int | ParamDataSize () const |
Returns the Size of the Parameter Data of the RDMCommand. | |
const uint8_t * | ParamData () const |
Returns the Parameter Data of the RDMCommand. | |
std::string | ToString () const |
Create a human readable string from the RDMCommand object. More... | |
Additional Inherited Members | |
Public Types inherited from ola::rdm::RDMCommand | |
enum | RDMCommandClass { DISCOVER_COMMAND = 0x10, DISCOVER_COMMAND_RESPONSE = 0x11, GET_COMMAND = 0x20, GET_COMMAND_RESPONSE = 0x21, SET_COMMAND = 0x30, SET_COMMAND_RESPONSE = 0x31, INVALID_COMMAND = 0xff } |
A set of values representing CommandClasses in E1.20. More... | |
Static Public Member Functions inherited from ola::rdm::RDMRequest | |
static RDMRequest * | InflateFromData (const uint8_t *data, unsigned int length) |
Inflate a request from some data. More... | |
Static Public Member Functions inherited from ola::rdm::RDMCommand | |
static RDMCommand * | Inflate (const uint8_t *data, unsigned int length) |
Extract a RDMCommand from raw data. More... | |
Static Public Attributes inherited from ola::rdm::RDMCommand | |
static const uint8_t | START_CODE = 0xcc |
The RDM Start Code. | |
Protected Member Functions inherited from ola::rdm::RDMCommand | |
RDMCommand (const UID &source, const UID &destination, uint8_t transaction_number, uint8_t port_id, uint8_t message_count, uint16_t sub_device, uint16_t param_id, const uint8_t *data, unsigned int length) | |
Protected constructor for derived classes. | |
void | SetParamData (const uint8_t *data, unsigned int length) |
Static Protected Member Functions inherited from ola::rdm::RDMCommand | |
static RDMStatusCode | VerifyData (const uint8_t *data, size_t length, RDMCommandHeader *command_message) |
static RDMCommandClass | ConvertCommandClass (uint8_t command_type) |
Protected Attributes inherited from ola::rdm::RDMRequest | |
OverrideOptions | m_override_options |
Protected Attributes inherited from ola::rdm::RDMCommand | |
uint8_t | m_port_id |
UID | m_source |
UID | m_destination |
uint8_t | m_transaction_number |
|
inline |
Create a new Get / Set Request.
source | The source UID. |
destination | The destination UID. |
transaction_number | The transaction number. |
port_id | The Port ID. |
sub_device | The Sub Device index. |
command_class | The Command Class of this request. |
param_id | The PID value. |
data | The parameter data, or NULL if there isn't any. |
length | The length of the parameter data. |
options | The OverrideOptions. |