Open Lighting Architecture  0.9.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
ola::rdm::PidStoreLoader Class Reference

Detailed Description

The PidStore Loader

Public Member Functions

const RootPidStoreLoadFromFile (const std::string &file, bool validate=true)
const RootPidStoreLoadFromDirectory (const std::string &directory, bool validate=true)
const RootPidStoreLoadFromStream (std::istream *data, bool validate=true)
template<typename pb_object >
bool GetPidList (vector< const PidDescriptor * > *pids, const pb_object &store, bool validate, bool limit_pid_values)

Member Function Documentation

template<typename pb_object >
bool ola::rdm::PidStoreLoader::GetPidList ( vector< const PidDescriptor * > *  pids,
const pb_object &  store,
bool  validate,
bool  limit_pid_values 
)

Get a list of pids from a protobuf object.

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

Load Pid information from a directory. This is an all-or-nothing load. Any error with cause us to abort the load.

Parameters
directorythe directory to load files from.
validateset to true if we should perform validation of the contents.
Returns
A pointer to a new RootPidStore or NULL if loading failed.
const RootPidStore * ola::rdm::PidStoreLoader::LoadFromFile ( const std::string &  file,
bool  validate = true 
)

Load Pid information from a file.

Parameters
filethe path to the file to load
validateset to true if we should perform validation of the contents.
Returns
A pointer to a new RootPidStore or NULL if loading failed.
const RootPidStore * ola::rdm::PidStoreLoader::LoadFromStream ( std::istream *  data,
bool  validate = true 
)

Load Pid information from a stream

Parameters
datathe input stream.
validateset to true if we should perform validation of the contents.
Returns
A pointer to a new RootPidStore or NULL if loading failed.

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