RDMnet  0.3.0
Implementation of ANSI E1.33 (RDMnet)
View other versions:
rdmnet::EptStatus Class Reference

Overview

An EPT status message received over RDMnet and delivered to an RDMnet callback function.

Not valid for use other than as a parameter to an RDMnet callback function; use EptStatus::Save() to create a copyable version.

#include <rdmnet/cpp/message_types/ept_status.h>

Public Member Functions

 EptStatus ()=delete
 Not default-constructible.
 
 EptStatus (const EptStatus &other)=delete
 Not copyable - use Save() to create a copyable version.
 
EptStatusoperator= (const EptStatus &other)=delete
 Not copyable - use Save() to create a copyable version.
 
constexpr EptStatus (const RdmnetEptStatus &c_status)
 Construct an EptStatus from an instance of the C RdmnetEptStatus type.
 
constexpr etcpal::Uuid source_cid () const noexcept
 Get the CID of the EPT client that sent this status message.
 
constexpr ept_status_code_t status_code () const noexcept
 Get the EPT status code of this status message.
 
constexpr const char * status_c_str () const noexcept
 Get the optional status string accompanying this status message.
 
std::string status_string () const
 Get the optional status string accompanying this status message.
 
const char * CodeToCString () const noexcept
 Convert the status message's code to a string representation.
 
std::string CodeToString () const
 Convert the status message's code to a string representation.
 
constexpr bool HasStatusString () const noexcept
 Determine whether the optional EPT status string is present.
 
constexpr const RdmnetEptStatusget () const noexcept
 Get a const reference to the underlying C type.
 
SavedEptStatus Save () const
 Save the data in this status message for later use from a different context. More...
 

Member Function Documentation

◆ Save()

SavedEptStatus rdmnet::EptStatus::Save ( ) const
inline

Save the data in this status message for later use from a different context.

Returns
A SavedEptStatus containing the copied data.

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