RDMnet  HEAD (unstable)
Implementation of ANSI E1.33 (RDMnet)
View other versions:
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Modules Pages
RptStatus Class Reference

Overview

An RPT 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 RptStatus::Save() to create a copyable version.

Public Member Functions

 RptStatus ()=delete
 Not default-constructible.
 
constexpr RptStatus (const RdmnetRptStatus &c_status)
 Construct an RptStatus from an instance of the C RdmnetRptStatus type.
 
constexpr rdm::Uid source_uid () const noexcept
 Get the UID of the RDMnet component that sent this RPT status message.
 
constexpr uint16_t source_endpoint () const noexcept
 Get the endpoint from which this RPT status message was sent.
 
constexpr uint32_t seq_num () const noexcept
 Get the RDMnet sequence number of this RPT status message, for matching with a corresponding command.
 
constexpr rpt_status_code_t status_code () const noexcept
 Get the RPT 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 RPT status string is present.
 
constexpr const RdmnetRptStatusget () const noexcept
 Get a const reference to the underlying C type.
 
SavedRptStatus Save () const
 Save the data in this status message for later use from a different context. More...
 

Member Function Documentation

◆ Save()

SavedRptStatus Save ( ) const
inline

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

Returns
A SavedRptStatus containing the copied data.

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