rdmnet::DynamicUidAssignmentList Class Reference

Overview

A list of mappings from dynamic UIDs to responder IDs received from an RDMnet broker.

Not valid for use other than as a parameter to an RDMnet callback function; use DynamicUidAssignmentList::GetMappings() to copy out the data.

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

Public Member Functions
	DynamicUidAssignmentList ()=delete
	Not default-constructible.
	DynamicUidAssignmentList (const DynamicUidAssignmentList &other)=delete
	Not copyable - use GetMappings() to copy out the data.
DynamicUidAssignmentList &	operator= (const DynamicUidAssignmentList &other)=delete
	Not copyable - use GetMappings() to copy out the data.
constexpr	DynamicUidAssignmentList (const RdmnetDynamicUidAssignmentList &c_list) noexcept
	Construct a DynamicUidAssignmentList which references an instance of the C RdmnetDynamicUidAssignmentList type.
std::vector< DynamicUidMapping >	GetMappings () const
	Copy out the list of dynamic UID mappings. More...
constexpr bool	more_coming () const noexcept
	This message contains a partial list. More...
constexpr const RdmnetDynamicUidMapping *	raw_mapping_array () const noexcept
	Get a pointer to the raw array of dynamic UID mapping C structures.
constexpr size_t	raw_mapping_array_size () const noexcept
	Get the size of the raw array of dynamic UID mapping C structures.

Member Function Documentation

GetMappings()

std::vector< DynamicUidMapping > rdmnet::DynamicUidAssignmentList::GetMappings ( ) const

inline

Copy out the list of dynamic UID mappings.

This function copies and translates the list delivered to a callback function into C++ native types.

more_coming()

constexpr bool rdmnet::DynamicUidAssignmentList::more_coming ( ) const

constexprnoexcept

This message contains a partial list.

This can be set when the library runs out of static memory in which to store Client Entries and must deliver the partial list before continuing. The application should store the entries in the list but should not act on the list until another DynamicUidAssignmentList is received with more_coming() == false.

---

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

• include/rdmnet/cpp/message_types/dynamic_uid.h