Open Lighting Architecture
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
ola::rdm::RDMGetSetRequest Class Reference

Detailed Description

The parent class for GET/SET requests.

Inheritance diagram for ola::rdm::RDMGetSetRequest:
ola::rdm::RDMRequest ola::rdm::RDMCommand ola::rdm::BaseRDMRequest< command_class >

Public Member Functions

 RDMGetSetRequest (const UID &source, const UID &destination, uint8_t transaction_number, uint8_t port_id, uint8_t message_count, uint16_t sub_device, RDMCommandClass command_class, uint16_t param_id, const uint8_t *data, unsigned int length)
- Public Member Functions inherited from ola::rdm::RDMRequest
 RDMRequest (const UID &source, const UID &destination, uint8_t transaction_number, uint8_t port_id, uint8_t message_count, uint16_t sub_device, RDMCommandClass command_class, uint16_t param_id, const uint8_t *data, unsigned int length)
RDMCommandClass CommandClass () const
 a virtual method to return the current CommmandClass.
uint8_t PortId () const
virtual RDMRequestDuplicate () const
virtual RDMRequestDuplicateWithControllerParams (const UID &source, uint8_t transaction_number, uint8_t port_id) const
virtual void Print (CommandPrinter *printer, bool summarize, bool unpack_param_data) const
 Used to print the data in an RDM Command to a CommandPrinter.
- Public Member Functions inherited from ola::rdm::RDMCommand
bool operator== (const RDMCommand &other) const
 Equality Operator.
rdm_message_type CommandType () const
 Used as a quick way to determine if the command is a request or a response.
void Write (ola::io::OutputStream *stream) const
 Write this RDMCommand to an OutputStream.
const UIDSourceUID () const
 Returns the Source UID of the RDMCommand.
const UIDDestinationUID () const
 Returns the Destination UID of the RDMCommand.
uint8_t TransactionNumber () const
 Returns the Transaction Number of the RDMCommand.
uint8_t MessageCount () const
 Returns the Message Count of the RDMCommand.
uint16_t SubDevice () const
 Returns the SubDevice of the RDMCommand.
uint8_t PortIdResponseType () const
 Returns the Port ID of the RDMCommand.
uint16_t ParamId () const
 Returns the Parameter ID of the RDMCommand.
uint8_t * ParamData () const
 Returns the Parameter Data of the RDMCommand.
unsigned int ParamDataSize () const
 Returns the Size of the Parameter Data of the RDMCommand.
std::string ToString () const
 Create a string from the RDMCommand object.

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 RDMRequestInflateFromData (const uint8_t *data, unsigned int length)
static RDMRequestInflateFromData (const string &data)
- Static Public Attributes inherited from ola::rdm::RDMCommand
static const uint8_t START_CODE = 0xcc
- 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)
void SetParamData (const uint8_t *data, unsigned int length)
- Static Protected Member Functions inherited from ola::rdm::RDMCommand
static rdm_response_code VerifyData (const uint8_t *data, unsigned int length, RDMCommandHeader *command_message)
static RDMCommandClass ConvertCommandClass (uint8_t command_type)
- Protected Attributes inherited from ola::rdm::RDMCommand
uint8_t m_port_id
- Friends inherited from ola::rdm::RDMCommand

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