Detailed Description

The root PID Store.

Public Types
typedef map< uint16_t, const PidStore * >	ManufacturerMap

Public Member Functions
	RootPidStore (const PidStore *esta_store, const ManufacturerMap &manufacturer_stores, uint64_t version=0)
	~RootPidStore ()
uint64_t	Version () const
const PidStore *	EstaStore () const
const PidStore *	ManufacturerStore (uint16_t esta_id) const
const PidDescriptor *	GetDescriptor (const string &pid_name) const
const PidDescriptor *	GetDescriptor (const string &pid_name, uint16_t manufacturer_id) const
const PidDescriptor *	GetDescriptor (uint16_t pid_value) const
const PidDescriptor *	GetDescriptor (uint16_t pid_value, uint16_t manufacturer_id) const

Static Public Member Functions
static const RootPidStore *	LoadFromFile (const std::string &file, bool validate=true)
static const RootPidStore *	LoadFromDirectory (const std::string &directory, bool validate=true)

Constructor & Destructor Documentation

ola::rdm::RootPidStore::~RootPidStore ( )

Clean up

const PidDescriptor * ola::rdm::RootPidStore::GetDescriptor ( const string & pid_name ) const

Lookup a PidDescriptor by name.

Parameters

pid_name the name of the pid

const PidDescriptor * ola::rdm::RootPidStore::GetDescriptor	(	const string &	pid_name,
		uint16_t	manufacturer_id
	)		const

Lookup a PidDescriptor by name in both the ESTA PIDs and any manufacturer PIDs.

Parameters

manufacturer_id	the ESTA id of the manufacturer_id
pid_name	the name of the pid

const PidDescriptor * ola::rdm::RootPidStore::GetDescriptor ( uint16_t pid_value ) const

Lookup a PidDescriptor by pid value.

Parameters

pid_value the pid to lookup

const PidDescriptor * ola::rdm::RootPidStore::GetDescriptor	(	uint16_t	pid_value,
		uint16_t	manufacturer_id
	)		const

Lookup a PidDescriptor by pid value in both the ESTA PIDs and any manufacturer PIDs.

Parameters

manufacturer_id	the ESTA id of the manufacturer_id
pid_value	the pid to lookup

const RootPidStore * ola::rdm::RootPidStore::LoadFromDirectory	(	const std::string &	directory,
		bool	validate = `true`
	)

static

Load all pid definition files in a directory

const RootPidStore * ola::rdm::RootPidStore::LoadFromFile	(	const std::string &	file,
		bool	validate = `true`
	)

static

Load a pid store from a file

const PidStore * ola::rdm::RootPidStore::ManufacturerStore ( uint16_t esta_id ) const

Lookup a PidStore based on Manufacturer Id

Parameters

esta_id the manufacturer id

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