RDMCommand.h File Reference

Detailed Description

Classes that represent RDM commands.

Go to the source code of this file.

Classes
class	ola::rdm::RDMCommand
	The base class that all RDM commands inherit from. More...
class	ola::rdm::RDMRequest
	RDM Commands that represent requests (GET, SET or DISCOVER). More...
class	ola::rdm::RDMGetSetRequest
	The parent class for GET/SET requests. More...
class	ola::rdm::BaseRDMRequest< command_class >
class	ola::rdm::RDMResponse
	The set of RDM Commands that represent responses (GET, SET or DISCOVER). More...
class	ola::rdm::RDMGetSetResponse
	The base class for GET/SET responses. More...
class	ola::rdm::BaseRDMResponse< command_class >
class	ola::rdm::RDMDiscoveryRequest
	An RDM request of type DISCOVER_COMMAND. More...
class	ola::rdm::RDMDiscoveryResponse
	An RDM response of type DISCOVER_COMMAND. More...

Namespaces
namespace	ola
	The namespace containing all OLA symbols.
namespace	ola::rdm
	PLASA E1.20 Remote Device Management.

Typedefs
typedef BaseRDMRequest < RDMCommand::GET_COMMAND >	ola::rdm::RDMGetRequest
typedef BaseRDMRequest < RDMCommand::SET_COMMAND >	ola::rdm::RDMSetRequest
typedef BaseRDMResponse < RDMCommand::GET_COMMAND_RESPONSE >	ola::rdm::RDMGetResponse
typedef BaseRDMResponse < RDMCommand::SET_COMMAND_RESPONSE >	ola::rdm::RDMSetResponse

Enumerations
enum	ola::rdm::rdm_message_type { ola::rdm::RDM_REQUEST, ola::rdm::RDM_RESPONSE, ola::rdm::RDM_INVALID }
	An OLA specific enum that allows us to tell if a command is a request or a response. See RDMCommandClass for more information. More...

Functions
bool	ola::rdm::GuessMessageType (rdm_message_type *type_arg, RDMCommand::RDMCommandClass *command_class_arg, const uint8_t *data, unsigned int length)
	Guess the type of an RDM message.
RDMResponse *	ola::rdm::NackWithReason (const RDMRequest *request, rdm_nack_reason reason_enum, uint8_t outstanding_messages)
RDMResponse *	ola::rdm::GetResponseFromData (const RDMRequest *request, const uint8_t *data, unsigned int length, rdm_response_type type, uint8_t outstanding_messages)
RDMResponse *	ola::rdm::GetResponseWithPid (const RDMRequest *request, uint16_t pid, const uint8_t *data, unsigned int length, uint8_t type, uint8_t outstanding_messages)
RDMDiscoveryRequest *	ola::rdm::NewDiscoveryUniqueBranchRequest (const UID &source, const UID &lower, const UID &upper, uint8_t transaction_number, uint8_t port_id=1)
	Create a new DUB request object.
RDMDiscoveryRequest *	ola::rdm::NewMuteRequest (const UID &source, const UID &destination, uint8_t transaction_number, uint8_t port_id=1)
	Create a new Mute Request Object.
RDMDiscoveryRequest *	ola::rdm::NewUnMuteRequest (const UID &source, const UID &destination, uint8_t transaction_number, uint8_t port_id)