DtComponentSystemDatabase Class Reference

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

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 const DtComponentSystemDefinition *	findSystemBySystemName (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.
virtual bool	removeSystem (const DtComponentSystemDefinition *systemDefinition)
	Removes the specified system from the database.

Protected Attributes
DtSystemDefinitionInfoList	mySystemDefinitions

Private Member Functions
	DtComponentSystemDatabase (const DtComponentSystemDatabase &orig)
	Not implemented.
DtComponentSystemDatabase &	operator= (const DtComponentSystemDatabase &orig)

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

DtComponentSystemDatabase::DtComponentSystemDatabase ( const DtComponentSystemDatabase &  orig )

private

Not implemented.

DtComponentSystemDatabase::DtComponentSystemDatabase

(

)

virtual DtComponentSystemDatabase::~DtComponentSystemDatabase ( )

virtual

Member Function Documentation

DtComponentSystemDatabase& DtComponentSystemDatabase::operator= ( const DtComponentSystemDatabase &  orig )

private

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 const DtComponentSystemDefinition* DtComponentSystemDatabase::findSystemBySystemName ( const DtFilename &  filename ) const

virtual

Returns

The DtComponentSystemDefinition pointer for the system that matches the name of the system (file name) regardless of the path that contains the system. If the given system to look for (filename) contains a path that path will be stripped off

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.

virtual bool DtComponentSystemDatabase::removeSystem ( const DtComponentSystemDefinition *  systemDefinition )

virtual

Removes the specified system from the database.

Member Data Documentation

DtSystemDefinitionInfoList DtComponentSystemDatabase::mySystemDefinitions

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfobjparam/componentSystemDatabase.h