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

Overview

An RPT status message received over RDMnet and saved for later processing.

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

Public Member Functions

 SavedRptStatus ()=default
 Constructs an empty, invalid RPT status by default.
 
 SavedRptStatus (const RdmnetSavedRptStatus &c_status)
 Construct a SavedRptStatus from an instance of the C RdmnetSavedRptStatus type.
 
SavedRptStatusoperator= (const RdmnetSavedRptStatus &c_status)
 Assign an instance of the C RdmnetSavedRptStatus type to an instance of this class.
 
 SavedRptStatus (const RptStatus &status)
 Construct a SavedRptStatus from an RptStatus.
 
SavedRptStatusoperator= (const RptStatus &status)
 Assign an RptStatus to an instance of this class.
 
const rdm::Uid & source_uid () const noexcept
 Get the UID of the RDMnet component that sent this RPT status message.
 
uint16_t source_endpoint () const noexcept
 Get the endpoint from which this RPT status message was sent.
 
uint32_t seq_num () const noexcept
 Get the RDMnet sequence number of this RPT status message, for matching with a corresponding command.
 
rpt_status_code_t status_code () const noexcept
 Get the RPT status code of this status message.
 
const std::stringstatus_string () const noexcept
 Get the optional status string accompanying this status message.
 
bool IsValid () const noexcept
 Whether the values contained in this class are valid for an RPT 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.
 
bool HasStatusString () const noexcept
 Determine whether the optional RPT status string is present.
 

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