Lightmetrica  0.0.1.50dbee3 (yosakoi)
 All Classes Functions Variables Typedefs Enumerations Enumerator
Public Member Functions | List of all members
Config Class Referenceabstract

#include <config.h>

Public Member Functions

 LM_COMPONENT_INTERFACE_DEF ("config")
 
virtual bool Load (const std::string &path)=0
 
virtual bool Load (const std::string &path, const std::string &basePath)=0
 
virtual bool LoadFromString (const std::string &data, const std::string &basePath)=0
 
virtual const ConfigNode Root () const =0
 
virtual std::string BasePath () const =0
 
- Public Member Functions inherited from Component
virtual std::string ComponentInterfaceTypeName () const =0
 
virtual std::string ComponentImplTypeName () const =0
 
- Public Member Functions inherited from SIMDAlignedType
void * operator new (std::size_t size) throw (std::bad_alloc)
 
void operator delete (void *p)
 

Detailed Description

Configuration of the renderer. The renderer is configured by a XML document. All configuration needed for rendering is contained the document.

Inheritance diagram for Config:
Component SIMDAlignedType ConfigImpl StubConfig StubConfig_PathUtilsTest

Member Function Documentation

virtual std::string Config::BasePath ( ) const
pure virtual

Get base path. Returns the base path of the assets.

Returns
Base path.

Implemented in ConfigImpl, StubConfig, and StubConfig_PathUtilsTest.

virtual bool Config::Load ( const std::string &  path)
pure virtual

Load the configuration file.

Parameters
pathPath to the configuration file.
Return values
trueSucceeded to load the configuration.
falseFailed to load the configuration.

Implemented in ConfigImpl, and StubConfig.

virtual bool Config::Load ( const std::string &  path,
const std::string &  basePath 
)
pure virtual

Load the configuration file.

Parameters
pathPath to the configuration file.
pathBase path for asset loading.
Return values
trueSucceeded to load the configuration.
falseFailed to load the configuration.

Implemented in ConfigImpl, and StubConfig.

virtual bool Config::LoadFromString ( const std::string &  data,
const std::string &  basePath 
)
pure virtual

Load the configuration from a string. Use the function to load the configuration from a string.

Parameters
dataConfiguration string.
basePathBase path for asset loading.
Return values
trueSucceeded to load the configuration.
falseFailed to load the configuration.

Implemented in ConfigImpl, and StubConfig.

virtual const ConfigNode Config::Root ( ) const
pure virtual

Get the root node.

Returns
Root node.

Implemented in ConfigImpl, and StubConfig.


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