DtComponentSystemDatabase Class Reference

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.

Inheritance diagram for DtComponentSystemDatabase:

Public Member Functions
	DtComponentSystemDatabase ()
virtual	~DtComponentSystemDatabase ()
virtual bool	loadSystemDefinition (const DtFilename &definitionFilename, const DtVariableBindingsList &variableBindings, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths())
virtual void	changeSystemFilename (const DtFilename &oldFilename, const DtFilename &newFilename)
virtual DtSystemDefinitionInfoList	findSystemsForCategoryAndSRType (const DtString &category, const DtString &stateRepType) const
virtual const DtComponentSystemDefinition *	findSystemByFilename (const DtFilename &filename) const
virtual DtComponentSystemDefinition *	findSystemByFilename (const DtFilename &filename)
virtual const DtComponentSystemDefinition *	findSystemBySystemName (const DtString &systemName) const
virtual DtComponentSystemDefinition *	findSystemBySystemName (const DtString &systemName)
virtual bool	replaceSystem (const DtFilename &definitionFilename, const DtVariableBindingsList &variableBindings)
virtual DtComponentSystemDefinition *	addSystem (const DtFilename &, const DtComponentSystemDefinition &)
virtual bool	saveSystem (const DtFilename &)
virtual bool	saveSystem (const DtComponentSystemDefinition *)
virtual bool	removeSystem (const DtFilename &definitionFilename)
virtual bool	removeSystem (const DtComponentSystemDefinition *systemDefinition)
virtual void	findAllVariableBindings (DtVariableBindingsList &list, const DtReaderWriter *rw) const
virtual bool	operator== (const DtComponentSystemDatabase &) const
virtual bool	operator!= (const DtComponentSystemDatabase &rhs) const
const DtSystemDefinitionMap &	systemDefinitions () const
DtSystemDefinitionMap &	systemDefinitions ()
virtual DtFilename	systemFilename (const DtComponentSystemDefinition *) const

Protected Attributes
DtSystemDefinitionMap	mySystemDefinitions

Private Member Functions
	DtComponentSystemDatabase (const DtComponentSystemDatabase &orig)
DtComponentSystemDatabase &	operator= (const DtComponentSystemDatabase &orig)

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

Not implemented.

virtual bool DtComponentSystemDatabase::loadSystemDefinition ( const DtFilename &  definitionFilename, const DtVariableBindingsList &  variableBindings, const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths()  )

virtual

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

Returns

True on success.

virtual void DtComponentSystemDatabase::changeSystemFilename ( const DtFilename &  oldFilename, const DtFilename &  newFilename  )

virtual

Changes the filename for the given system to the new filename.

Reimplemented in DtSimulationObjectEditorComponentSystemDatabase.

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

virtual

virtual const DtComponentSystemDefinition* DtComponentSystemDatabase::findSystemBySystemName ( const DtString &  systemName ) const

virtual

Returns

The DtComponentSystemDefinition pointer for the system that matches the name of the system (meta data system name)

virtual DtComponentSystemDefinition* DtComponentSystemDatabase::findSystemBySystemName ( const DtString &  systemName )

virtual

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

virtual

Adds the system given the filename and component definition, which will be cloned and then taken control of by this database. The new member is returned. If the system exists will remove old system.

Reimplemented in DtSimulationObjectEditorComponentSystemDatabase.

virtual bool DtComponentSystemDatabase::saveSystem ( const DtFilename &  )

virtual

Saves the system that is represented by the given filename.

Reimplemented in DtSimulationObjectEditorComponentSystemDatabase.

virtual bool DtComponentSystemDatabase::saveSystem ( const DtComponentSystemDefinition *  )

virtual

Save the given system descriptor the filename that is associated with it.

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

virtual

Removes the specified system from the database.

Reimplemented in DtSimulationObjectEditorComponentSystemDatabase.

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

virtual

Removes the specified system from the database.

virtual void DtComponentSystemDatabase::findAllVariableBindings ( DtVariableBindingsList &  list, const DtReaderWriter *  rw  ) const

virtual

Returns all the "varible-bindings" sections in the supplied list. The list will be appended to, so, clear it if you want to remove any existing bindings before passing in.

virtual bool DtComponentSystemDatabase::operator== ( const DtComponentSystemDatabase &  ) const

virtual

virtual bool DtComponentSystemDatabase::operator!= ( const DtComponentSystemDatabase &  rhs ) const

inlinevirtual

const DtSystemDefinitionMap& DtComponentSystemDatabase::systemDefinitions ( ) const

inline

DtSystemDefinitionMap& DtComponentSystemDatabase::systemDefinitions ( )

inline

This class owns the pointers to the system definitions so do not hold onto pointers. Use this for modification only.

virtual DtFilename DtComponentSystemDatabase::systemFilename ( const DtComponentSystemDefinition *  ) const

virtual

Returns the filename for the given component definition.

Member Data Documentation

DtSystemDefinitionMap DtComponentSystemDatabase::mySystemDefinitions

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjparam/componentSystemDatabase.h