Open Lighting Architecture
Latest Git
|
Holds the final state of an RDM request.
When a RDM request completes, the following information is returned:
Public Member Functions | |
RDMReply (RDMStatusCode status_code) | |
Create a new RDMReply from a RDM Response Code. | |
RDMReply (RDMStatusCode status_code, RDMResponse *response) | |
Create a RDMReply with a response code and response object. More... | |
RDMReply (RDMStatusCode status_code, RDMResponse *response, const RDMFrames &frames) | |
Create a RDMReply with a response code and response object. More... | |
RDMStatusCode | StatusCode () const |
Return the RDMStatusCode for the request. | |
const RDMResponse * | Response () const |
Returns the RDMResponse if there is one. More... | |
RDMResponse * | MutableResponse () |
Returns a pointer to a mutable RDMResponse. More... | |
const RDMFrames & | Frames () const |
The frames that make up this RDM reply. More... | |
bool | operator== (const RDMReply &other) const |
Test for equality. More... | |
Static Public Member Functions | |
static RDMReply * | FromFrame (const RDMFrame &frame, const RDMRequest *request=NULL) |
A helper method to create a RDMReply from raw frame data. More... | |
static RDMReply * | DUBReply (const RDMFrame &frame) |
A helper method to create a RDMReply for a DUB response. More... | |
String Methods | |
std::string | ToString () const |
Create a human readable string from the RDMReply object. More... | |
std::ostream & | operator<< (std::ostream &out, const RDMReply &reply) |
Output an RDMReply object to an ostream. More... | |
ola::rdm::RDMReply::RDMReply | ( | RDMStatusCode | status_code, |
RDMResponse * | response | ||
) |
Create a RDMReply with a response code and response object.
status_code | The RDMStatusCode. |
response | The RDMResponse object, ownership is transferred. |
ola::rdm::RDMReply::RDMReply | ( | RDMStatusCode | status_code, |
RDMResponse * | response, | ||
const RDMFrames & | frames | ||
) |
Create a RDMReply with a response code and response object.
status_code | The RDMStatusCode. |
response | The RDMResponse object, ownership is transferred. |
frames | The raw RDM frames that make up the response. |
A helper method to create a RDMReply for a DUB response.
frame | A RDMFrame of DUB data. |
|
inline |
The frames that make up this RDM reply.
This may be empty, if the raw frame data was not available.
|
static |
A helper method to create a RDMReply from raw frame data.
frame | A RDMFrame. |
request | An optional RDMRequest that triggered this response. |
|
inline |
Returns a pointer to a mutable RDMResponse.
The returned pointer is valid for the lifetime of the RDMReply object.
bool ola::rdm::RDMReply::operator== | ( | const RDMReply & | other | ) | const |
Test for equality.
other | The RDMReply to test against. |
|
inline |
Returns the RDMResponse if there is one.
The returned pointer is valid for the lifetime of the RDMReply object.
std::string ola::rdm::RDMReply::ToString | ( | ) | const |
|
friend |
Output an RDMReply object to an ostream.
out | ostream to output to |
reply | is the RDMReply to print |