Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules 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)
 Load PID information from a file. More...
 
const RootPidStoreLoadFromDirectory (const std::string &directory, bool validate=true)
 Load PID information from a directory, including overrides. More...
 
const RootPidStoreLoadFromStream (std::istream *data, bool validate=true)
 Load Pid information from a stream. More...
 
template<typename descriptor_class >
const FieldDescriptorIntegerFieldToFieldDescriptor (const ola::rdm::pid::Field &field)
 

Member Function Documentation

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

Load PID information from a directory, including overrides.

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.

This is an all-or-nothing load. Any error with cause us to abort the load.

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: