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

Overview

A mapping from a dynamic UID to a responder ID (RID).

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

Public Member Functions

 DynamicUidMapping (const RdmnetDynamicUidMapping &c_mapping)
 Construct an DynamicUidMapping copied from an instance of the C RdmnetDynamicUidMapping type.
 
DynamicUidMappingoperator= (const RdmnetDynamicUidMapping &c_mapping)
 Assign an instance of the C RdmnetDynamicUidMapping type to an instance of this class.
 
constexpr bool IsOk () const noexcept
 Whether a DynamicUidMapping has a status code of OK. More...
 
const char * CodeToCString () const noexcept
 Convert the mapping status code to a string representation.
 
std::string CodeToString () const
 Convert the mapping status code to a string representation.
 

Data Fields

rdmnet_dynamic_uid_status_t status_code {kRdmnetDynamicUidStatusOk}
 The response code - indicating whether the broker was able to assign or look up this dynamic UID.
 
rdm::Uid uid
 The dynamic UID.
 
etcpal::Uuid rid
 The corresponding RID to which the dynamic UID is mapped.
 

Member Function Documentation

◆ IsOk()

constexpr bool rdmnet::DynamicUidMapping::IsOk ( ) const
constexprnoexcept

Whether a DynamicUidMapping has a status code of OK.

An OK status code indicates a successful UID assignment or RID lookup.


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