23 #ifndef RDMNET_CPP_MESSAGE_TYPES_EPT_STATUS_H_
24 #define RDMNET_CPP_MESSAGE_TYPES_EPT_STATUS_H_
84 bool IsValid() const noexcept;
92 std::
string status_string_;
107 return status_.source_cid;
113 return status_.status_code;
119 return status_.status_string;
125 return status_.status_string;
131 return status_.status_string;
137 return status_.status_string;
143 return (status_.status_string !=
nullptr);
183 : source_cid_(status.source_cid()), status_code_(status.status_code()), status_string_(status.status_string())
211 return status_string_;
217 return !source_cid_.
IsNull();
235 return !status_string_.
empty();
bool IsNull() const noexcept
An EPT status message received over RDMnet and delivered to an RDMnet callback function.
Definition: ept_status.h:41
std::string status_string() const
Get the optional status string accompanying this status message.
Definition: ept_status.h:123
EptStatus & operator=(const EptStatus &other)=delete
Not copyable - use Save() to create a copyable version.
const char * CodeToCString() const noexcept
Convert the status message's code to a string representation.
Definition: ept_status.h:129
constexpr ept_status_code_t status_code() const noexcept
Get the EPT status code of this status message.
Definition: ept_status.h:111
constexpr const RdmnetEptStatus & get() const noexcept
Get a const reference to the underlying C type.
Definition: ept_status.h:147
constexpr bool HasStatusString() const noexcept
Determine whether the optional EPT status string is present.
Definition: ept_status.h:141
std::string CodeToString() const
Convert the status message's code to a string representation.
Definition: ept_status.h:135
SavedEptStatus Save() const
Save the data in this status message for later use from a different context.
Definition: ept_status.h:154
EptStatus()=delete
Not default-constructible.
constexpr etcpal::Uuid source_cid() const noexcept
Get the CID of the EPT client that sent this status message.
Definition: ept_status.h:105
constexpr const char * status_c_str() const noexcept
Get the optional status string accompanying this status message.
Definition: ept_status.h:117
EptStatus(const EptStatus &other)=delete
Not copyable - use Save() to create a copyable version.
An EPT status message received over RDMnet and saved for later processing.
Definition: ept_status.h:71
const etcpal::Uuid & source_cid() const noexcept
Get the CID of the EPT client that sent this EPT status message.
Definition: ept_status.h:197
std::string CodeToString() const
Convert the status message's code to a string representation.
Definition: ept_status.h:227
const char * CodeToCString() const noexcept
Convert the status message's code to a string representation.
Definition: ept_status.h:221
SavedEptStatus()=default
Constructs an empty, invalid EPT status by default.
SavedEptStatus & operator=(const RdmnetSavedEptStatus &c_resp)
Assign an instance of the C RdmnetSavedEptStatus type to an instance of this class.
Definition: ept_status.h:172
bool IsValid() const noexcept
Whether the values contained in this class are valid for an EPT status message.
Definition: ept_status.h:215
const std::string & status_string() const noexcept
Get the optional status string accompanying this status message.
Definition: ept_status.h:209
ept_status_code_t status_code() const noexcept
Get the EPT status code of this status message.
Definition: ept_status.h:203
bool HasStatusString() const noexcept
Determine whether the optional EPT status string is present.
Definition: ept_status.h:233
Functions and definitions common to all RDMnet API modules.
const char * rdmnet_ept_status_code_to_string(ept_status_code_t code)
Get a string representation of an EPT status code.
Definition: common.c:250
ept_status_code_t
EPT status code definitions.
Definition: common.h:76
Basic types for parsed RDMnet messages.
A namespace which contains all C++ language definitions in the RDMnet library.
Definition: broker.h:45
An RDMnet EPT status message received by a local component.
Definition: message.h:309
An EPT status received over RDMnet and saved for later processing.
Definition: message.h:327
ept_status_code_t status_code
A status code that indicates the specific error or status condition.
Definition: message.h:331
const char * status_string
An optional implementation-defined status string to accompany this status message.
Definition: message.h:337
EtcPalUuid source_cid
The CID of the EPT client that sent this status message.
Definition: message.h:329