rdmnet::VirtualEndpointConfig Class Reference

Overview

Configuration information for a virtual endpoint on a device.

Can be implicitly converted from a simple endpoint number to create an endpoint configuration with no initial responders, e.g.:

rdmnet::VirtualEndpointConfig endpoint_config = 1;

Or use the constructors to create an endpoint with responders:

std::vector<etcpal::Uuid> dynamic_responders;
dynamic_responders.push_back(responder_id_1);
dynamic_responders.push_back(responder_id_2);
rdmnet::VirtualEndpointConfig endpoint_config(2, dynamic_responders);

See Devices and Gateways for more information about endpoints.

#include <rdmnet/cpp/device.h>

Public Member Functions
	VirtualEndpointConfig (uint16_t id, const etcpal::Uuid *dynamic_responders=nullptr, size_t num_dynamic_responders=0)
	Create a virtual endpoint configuration with an optional set of virtual responders with dynamic UIDs. More...
	VirtualEndpointConfig (uint16_t id, const std::vector< etcpal::Uuid > &dynamic_responders)
	Create a virtual endpoint configuration with a set of virtual responders with dynamic UIDs. More...
	VirtualEndpointConfig (uint16_t id, const rdm::Uid *static_responders, size_t num_static_responders, const etcpal::Uuid *dynamic_responders=nullptr, size_t num_dynamic_responders=0)
	Create a virtual endpoint configuration with a set of virtual responders. More...
	VirtualEndpointConfig (uint16_t id, const std::vector< rdm::Uid > &static_responders, const std::vector< etcpal::Uuid > &dynamic_responders=std::vector< etcpal::Uuid >{})
	Create a virtual endpoint configuration with a set of virtual responders. More...
const RdmnetVirtualEndpointConfig &	get () const noexcept
	Get a const reference to the underlying C type.

Constructor & Destructor Documentation

VirtualEndpointConfig() [1/4]

rdmnet::VirtualEndpointConfig::VirtualEndpointConfig ( uint16_t  id, const etcpal::Uuid *  dynamic_responders = nullptr, size_t  num_dynamic_responders = 0  )

inline

Create a virtual endpoint configuration with an optional set of virtual responders with dynamic UIDs.

Parameters

id	Endpoint ID - must be between 1 and 63,999 inclusive.
dynamic_responders	Array of responder IDs identifying the initial virtual responders present on the endpoint.
num_dynamic_responders	Size of responders array.

VirtualEndpointConfig() [2/4]

rdmnet::VirtualEndpointConfig::VirtualEndpointConfig ( uint16_t  id, const std::vector< etcpal::Uuid > &  dynamic_responders  )

inline

Create a virtual endpoint configuration with a set of virtual responders with dynamic UIDs.

Parameters

id	Endpoint ID - must be between 1 and 63,999 inclusive.
dynamic_responders	Responder IDs identifying the initial virtual responders present on the endpoint.

VirtualEndpointConfig() [3/4]

rdmnet::VirtualEndpointConfig::VirtualEndpointConfig ( uint16_t  id, const rdm::Uid *  static_responders, size_t  num_static_responders, const etcpal::Uuid *  dynamic_responders = nullptr, size_t  num_dynamic_responders = 0  )

inline

Create a virtual endpoint configuration with a set of virtual responders.

Parameters

id	Endpoint ID - must be between 1 and 63,999 inclusive.
static_responders	Array of UIDs identifying the initial virtual responders with static UIDs present on the endpoint.
num_static_responders	Size of static_responders array.
dynamic_responders	(optional) Array of responder IDs identifying the initial virtual responders with dynamic UIDs present on the endpoint.
num_dynamic_responders	(optional) Size of dynamic_responders array.

VirtualEndpointConfig() [4/4]

rdmnet::VirtualEndpointConfig::VirtualEndpointConfig ( uint16_t  id, const std::vector< rdm::Uid > &  static_responders, const std::vector< etcpal::Uuid > &  dynamic_responders = std::vector<etcpal::Uuid>{}  )

inline

Create a virtual endpoint configuration with a set of virtual responders.

Parameters

id	Endpoint ID - must be between 1 and 63,999 inclusive.
static_responders	UIDs identifying the initial virtual responders with static UIDs present on the endpoint.
dynamic_responders	(optional) Responder IDs identifying the initial virtual responders with dynamic UIDs present on the endpoint.

---

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

• include/rdmnet/cpp/device.h