Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
Ogre::ParamDictionary Class Reference

Class to hold a dictionary of parameters for a single class. More...

#include <OgreStringInterface.h>

Public Member Functions

 ParamDictionary ()
 
void addParameter (const ParameterDef &paramDef, ParamCommand *paramCmd)
 Method for adding a parameter definition for this class. More...
 
const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object. More...
 

Protected Member Functions

ParamCommandgetParamCommand (const String &name)
 Retrieves the parameter command object for a named parameter. More...
 
const ParamCommandgetParamCommand (const String &name) const
 

Protected Attributes

ParamCommandMap mParamCommands
 Command objects to get/set. More...
 
ParameterList mParamDefs
 Definitions of parameters. More...
 

Friends

class StringInterface
 

Detailed Description

Class to hold a dictionary of parameters for a single class.

Definition at line 90 of file OgreStringInterface.h.

Constructor & Destructor Documentation

Ogre::ParamDictionary::ParamDictionary ( )

Definition at line 127 of file OgreStringInterface.h.

Member Function Documentation

void Ogre::ParamDictionary::addParameter ( const ParameterDef paramDef,
ParamCommand paramCmd 
)

Method for adding a parameter definition for this class.

Parameters
paramDefA ParameterDef object defining the parameter
paramCmdPointer to a ParamCommand subclass to handle the getting / setting of this parameter. NB this class will not destroy this on shutdown, please ensure you do

Definition at line 134 of file OgreStringInterface.h.

References Ogre::ParameterDef::name.

ParamCommand* Ogre::ParamDictionary::getParamCommand ( const String name)
protected

Retrieves the parameter command object for a named parameter.

Definition at line 101 of file OgreStringInterface.h.

Referenced by Ogre::StringInterface::getParameter().

const ParamCommand* Ogre::ParamDictionary::getParamCommand ( const String name) const
protected

Definition at line 114 of file OgreStringInterface.h.

const ParameterList& Ogre::ParamDictionary::getParameters ( void  ) const

Retrieves a list of parameters valid for this object.

Returns
A reference to a static list of ParameterDef objects.

Definition at line 144 of file OgreStringInterface.h.

Friends And Related Function Documentation

friend class StringInterface
friend

Definition at line 92 of file OgreStringInterface.h.

Member Data Documentation

ParamCommandMap Ogre::ParamDictionary::mParamCommands
protected

Command objects to get/set.

Definition at line 98 of file OgreStringInterface.h.

ParameterList Ogre::ParamDictionary::mParamDefs
protected

Definitions of parameters.

Definition at line 95 of file OgreStringInterface.h.

Referenced by Ogre::StringInterface::copyParametersTo().


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

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Tue Mar 18 2014 19:15:54