VR-Forces 4.0.4 Class Documentation
Public Member Functions | Protected Attributes
DtComponentSystemDatabase Class Reference

This class maintains a database of a set of DtComponentSystemDefinition instances. More...

List of all members.

Public Member Functions

 DtComponentSystemDatabase ()
virtual ~DtComponentSystemDatabase ()
virtual bool loadSystemDefinition (const DtFilename &definitionFilename, const DtVariableBindingsList &variableBindings)
 Loads the system definition specified, and adds the system to the database.
virtual DtSystemDefinitionInfoList findSystemsForCategoryAndSRType (const DtString &category, const DtString &stateRepType) const
virtual const
DtComponentSystemDefinition
findSystemByFilename (const DtFilename &filename) const
virtual bool replaceSystem (const DtFilename &definitionFilename, const DtVariableBindingsList &variableBindings)
 Replaces the system specified by the filename in the list.
virtual bool removeSystem (const DtFilename &definitionFilename)
 Removes the specified system from the database.

Protected Attributes

DtSystemDefinitionInfoList mySystemDefinitions

Private Member Functions

 DtComponentSystemDatabase (const DtComponentSystemDatabase &orig)
 Not implemented.
DtComponentSystemDatabaseoperator= (const DtComponentSystemDatabase &orig)
 Not implemented.

Detailed Description

This class maintains a database of a set of DtComponentSystemDefinition instances.

This is intended for use by things such as the Entity Editor which needs to load up all the system definitions available, and then find the appropriate ones for particular queries.


Constructor & Destructor Documentation

Not implemented.


Member Function Documentation

DtComponentSystemDatabase& DtComponentSystemDatabase::operator= ( const DtComponentSystemDatabase orig) [private]

Not implemented.

virtual bool DtComponentSystemDatabase::loadSystemDefinition ( const DtFilename &  definitionFilename,
const DtVariableBindingsList variableBindings 
) [virtual]

Loads the system definition specified, and adds the system to the database.

Returns:
True on success.
virtual DtSystemDefinitionInfoList DtComponentSystemDatabase::findSystemsForCategoryAndSRType ( const DtString category,
const DtString stateRepType 
) const [virtual]
Returns:
A list of system definition info entries that are for a specific category and state repository type. Null strings in either of these fields will match any system.
virtual const DtComponentSystemDefinition* DtComponentSystemDatabase::findSystemByFilename ( const DtFilename &  filename) const [virtual]
Returns:
The DtComponentSystemDefinition pointer for the system that was loaded from the specified filename. This doesn't cause the system to be loaded, but just looks though the loaded system definitions.
virtual bool DtComponentSystemDatabase::replaceSystem ( const DtFilename &  definitionFilename,
const DtVariableBindingsList variableBindings 
) [virtual]

Replaces the system specified by the filename in the list.

If the filename does not exist in the list, it will load it

virtual bool DtComponentSystemDatabase::removeSystem ( const DtFilename &  definitionFilename) [virtual]

Removes the specified system from the database.


Member Data Documentation


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)