Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

Ogre::ParamDictionary Class Reference

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

#include <OgreStringInterface.h>

List of all members.

Public Member Functions

 ParamDictionary ()
void addParameter (const ParameterDef &paramDef, ParamCommand *paramCmd)
 Method for adding a parameter definition for this class.

const ParameterListgetParameters (void) const
 Retrieves a list of parameters valid for this object.


Protected Member Functions

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

const ParamCommandgetParamCommand (const String &name) const

Protected Attributes

ParameterList mParamDefs
 Definitions of parameters.

ParamCommandMap mParamCommands
 Command objects to get/set.


Friends

class StringInterface


Detailed Description

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

Definition at line 79 of file OgreStringInterface.h.


Constructor & Destructor Documentation

Ogre::ParamDictionary::ParamDictionary  ) 
 

Definition at line 116 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:
paramDef A ParameterDef object defining the parameter
paramCmd Pointer 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 123 of file OgreStringInterface.h.

References Ogre::ParameterDef::name.

const ParamCommand* Ogre::ParamDictionary::getParamCommand const String name  )  const [protected]
 

Definition at line 103 of file OgreStringInterface.h.

References Ogre::String.

ParamCommand* Ogre::ParamDictionary::getParamCommand const String name  )  [protected]
 

Retrieves the parameter command object for a named parameter.

Definition at line 90 of file OgreStringInterface.h.

References Ogre::String.

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

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 133 of file OgreStringInterface.h.

References Ogre::ParameterList.


Friends And Related Function Documentation

friend class StringInterface [friend]
 

Definition at line 81 of file OgreStringInterface.h.


Member Data Documentation

ParamCommandMap Ogre::ParamDictionary::mParamCommands [protected]
 

Command objects to get/set.

Definition at line 87 of file OgreStringInterface.h.

ParameterList Ogre::ParamDictionary::mParamDefs [protected]
 

Definitions of parameters.

Definition at line 84 of file OgreStringInterface.h.

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


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Feb 12 13:04:09 2006