Open Lighting Architecture
Latest Git
|
The root of the RDM parameter descriptor store.
The root parameter store holds the ESTA (formerly known as PLASA, formerly known as ESTA) parameters as well as any manufacturer defined parameters. Parameter definitions are loaded from .proto files, which are generated by the http://rdm.openlighting.org site.
Each parameter has an 16bit identifier (PID).
ESTA PIDs are those defined by the E1.X series of documents. To date this includes:
An overrides.proto file can be used as a local system override of any PID data. This allows manufacturers to specify their own manufacturer specific commands and for testing of draft PIDs.
Public Types | |
typedef std::map< uint16_t, const PidStore * > | ManufacturerMap |
Public Member Functions | |
RootPidStore (const PidStore *esta_store, const ManufacturerMap &manufacturer_stores, uint64_t version=0) | |
Create a new RootPidStore. More... | |
uint64_t | Version () const |
The version of the RDM parameter data. More... | |
const PidStore * | EstaStore () const |
Return the PidStore for ESTA (PLASA) parameters. More... | |
const PidStore * | ManufacturerStore (uint16_t esta_id) const |
Return the PidStore for a manufacturer. More... | |
const PidDescriptor * | GetDescriptor (const std::string &pid_name) const |
Lookup an ESTA-defined parameter by name. More... | |
const PidDescriptor * | GetDescriptor (const std::string &pid_name, uint16_t manufacturer_id) const |
Lookup a parameter by name in both the ESTA and the specified manufacturer store. More... | |
const PidDescriptor * | GetDescriptor (uint16_t pid_value) const |
Look up a ESTA-defined parameter by PID. More... | |
const PidDescriptor * | GetDescriptor (uint16_t pid_value, uint16_t manufacturer_id) const |
Lookup a parameter by PID in both the ESTA and the specified manufacturer store. More... | |
Static Public Member Functions | |
static const RootPidStore * | LoadFromFile (const std::string &file, bool validate=true) |
Load a RootPidStore from a file. More... | |
static const RootPidStore * | LoadFromDirectory (const std::string &directory, bool validate=true) |
Load a RootPidStore from a directory. More... | |
static const std::string | DataLocation () |
Returns the location of the installed PID data. More... | |
|
inline |
Create a new RootPidStore.
Most code shouldn't have to use this. Use RootPidStore::LoadFromFile or RootPidStore::LoadFromDirectory instead.
|
static |
Returns the location of the installed PID data.
|
inline |
Return the PidStore for ESTA (PLASA) parameters.
const PidDescriptor * ola::rdm::RootPidStore::GetDescriptor | ( | const std::string & | pid_name | ) | const |
Lookup an ESTA-defined parameter by name.
pid_name | the name of the parameter. |
const PidDescriptor * ola::rdm::RootPidStore::GetDescriptor | ( | const std::string & | pid_name, |
uint16_t | manufacturer_id | ||
) | const |
Lookup a parameter by name in both the ESTA and the specified manufacturer store.
pid_name | the name of the parameter to look for. |
manufacturer_id | the ESTA id of the manufacturer. |
const PidDescriptor * ola::rdm::RootPidStore::GetDescriptor | ( | uint16_t | pid_value | ) | const |
Look up a ESTA-defined parameter by PID.
pid_value | the PID to lookup. |
const PidDescriptor * ola::rdm::RootPidStore::GetDescriptor | ( | uint16_t | pid_value, |
uint16_t | manufacturer_id | ||
) | const |
Lookup a parameter by PID in both the ESTA and the specified manufacturer store.
pid_value | the pid to lookup |
manufacturer_id | the ESTA id of the manufacturer. |
|
static |
Load a RootPidStore from a directory.
directory | the directory containing the PID data. If directory is empty, the installed location will be used. |
validate | whether to perform validation on the data. Validation can be turned off for faster load times. |
|
static |
Load a RootPidStore from a file.
file | the file to load |
validate | whether to perform validation on the data. Validation can be turned off for faster load times. |
const PidStore * ola::rdm::RootPidStore::ManufacturerStore | ( | uint16_t | esta_id | ) | const |
|
inline |
The version of the RDM parameter data.