rdmnet::Controller::RdmData Struct Reference

Overview

A set of initial identifying RDM data to use for a controller.

#include <rdmnet/cpp/controller.h>

Public Member Functions
	RdmData ()=default
	Create an empty, invalid structure by default - must be filled in before passing to Controller::Startup().
	RdmData (uint16_t new_model_id, uint32_t new_software_version_id, const char *new_manufacturer_label, const char *new_device_model_description, const char *new_software_version_label, const char *new_device_label)
	Create a controller RdmData instance by passing all members which do not have a default value.
	RdmData (uint16_t new_model_id, uint32_t new_software_version_id, const std::string &new_manufacturer_label, const std::string &new_device_model_description, const std::string &new_software_version_label, const std::string &new_device_label)
	Create a controller RdmData instance by passing all members which do not have a default value.
bool	IsValid () const
	Whether this data is valid (all string members are non-empty).

Data Fields
uint16_t	model_id {0}
	A number representing the product model which implements the controller. More...
uint32_t	software_version_id {0}
	A number representing the version of the controller software. More...
uint16_t	product_category {E120_PRODUCT_CATEGORY_CONTROL_CONTROLLER}
	A number representing the product's primary function. More...
std::string	manufacturer_label
	The manufacturer name of the controller.
std::string	device_model_description
	The name of the product model which implements the controller.
std::string	software_version_label
	The software version of the controller as a string.
std::string	device_label
	A user-settable name for this controller instance.
bool	device_label_settable {false}
	Whether the library should allow device_label to be changed remotely.

Field Documentation

model_id

uint16_t rdmnet::Controller::RdmData::model_id {0}

A number representing the product model which implements the controller.

Should be unique per model for a given manufacturer.

product_category

uint16_t rdmnet::Controller::RdmData::product_category {E120_PRODUCT_CATEGORY_CONTROL_CONTROLLER}

A number representing the product's primary function.

Valid values are defined in rdm/defs.h as E120_PRODUCT_CATEGORY_...

software_version_id

uint32_t rdmnet::Controller::RdmData::software_version_id {0}

A number representing the version of the controller software.

Should be unique per version of a given controller's application.

---

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

• include/rdmnet/cpp/controller.h