makVrv::DtModelPreloadManager Class Reference

DtModelPreloadManager is responsible for managing models to preload and tracking loaded models that were not in the preload list. More...

Inheritance diagram for makVrv::DtModelPreloadManager:

Public Types
typedef boost::unordered_set < std::string >	ModelDefinitionMap
typedef boost::unordered_set < std::string >	ModelSchemaMap

Public Member Functions
virtual	~DtModelPreloadManager ()
	DTOR. More...
virtual void	addModelDefinitionToPreloadList (const std::string &modelDefName)
	Add the model definition to the preload list. More...
virtual void	removeModelDefinitionFromPreloadList (const std::string &modelDefName)
	Remove the model definition from the preload list. More...
virtual void	addModelDefinitionToDiscoveredModelList (const std::string &modelDefName)
	Add the model definition to the discovered model list. More...
virtual void	removeModelDefinitionFromDiscoveredModelList (const std::string &modelDefName)
	Remove the model definition from the discovered model list. More...
virtual void	addSchemaToValidList (const std::string &schemaName)
	Add schema to the list of valid schema for preloading. More...
virtual void	removeSchemaFromValidList (const std::string &schemaName)
	Remove schema from the list of valid schema for preloading. More...
virtual bool	isValidModelDefinition (const std::string &modelDefName)
	Return true if schema of the model definition is a valid one for preloading. More...
virtual bool	isValidModelSchema (const std::string &schemaName)
	Return true if schema is a valid one for preloading. More...
const std::string &	preloadFilename () const
	Get the filename containing the model definitions to preload. More...
virtual void	setPreloadFilename (const std::string &filename)
	Set the filename containing the model definitions to preload. More...
const std::string &	discoveredModelsFilename () const
	Get the filename containing the models loaded that were not in the preload model list. More...
void	setDiscoveredModelsFilename (const std::string &filename)
	Set the filename containing the models loaded that were not in the preload model list. More...
virtual void	clearPreloadList ()
	Clears the preload model list. More...
virtual void	loadDefaults (bool loadOnlyFactorSettings=false)
	Load the default settings. More...
virtual void	saveAsDefaults ()
	Called to save the current settings as the default settings. More...
virtual void	exportSettings (const std::string &filename)
	Exports the current settings to a file. More...
virtual void	exportDiscoveredSettings (const std::string &filename)
	Exports the current discovered settings to a file. More...
virtual void	importSettings (const std::string &filename)
	Imports the current settings from a file. More...
virtual void	mergeSettings (const std::string &filename)
	Imports settings from a file merging with the current settings. More...
virtual DtBackupInterface *	backup ()
	Get the settings back for the preload model list. More...
virtual void	setModelPreloadFromRecord (const makArchives::DtModelPreloadSetRecord &rec)
	Set the model preload list in the manager from a record. More...
virtual void	getModelPreloadRecord (makArchives::DtModelPreloadSetRecord &rec) const
	Get a record containing the model preload list in the manager. More...
virtual void	getDiscoveredModelPreloadRecord (makArchives::DtModelPreloadSetRecord &rec) const
	Get a record containing the model preload list in the manager. More...
bool	isInPreloadList (const std::string &modelDefName) const
	Returns true of model is in the model preload list. More...
virtual bool	preloadModels ()
	Preload all models in the preload model list. More...
virtual void	slot_modelCreated (DtModelInstance &modelInstance)
	Called when a model instance is created. More...
virtual void	slot_displayEngineAdded (const DtDeRecord &deRec)
	Receives notification that a new De has been connected for propagation of preloaded models display engines. More...
virtual void	slot_quit ()
	Receives notification that a new De has been connected. More...
const ModelDefinitionMap &	preloadModelMap () const
	Get the container of preload models. More...
void	setSettingsManager (DtModelPreloadSettingsManager *settingsMgr)
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor. More...
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor. More...

Static Public Member Functions
static DtModelPreloadManager &	instance (DtDe &de)
	Create and register the DtPreloadModelManager. More...

Protected Member Functions
	DtModelPreloadManager (DtDe &de)
	CTOR. More...

Protected Attributes
DtDe &	myDe
DtModelPreloaderAgent *	myAgent
DtMetaFileManager *	myMetaFileManager
std::string	myPreloadModelFilename
std::string	myDiscoveredModelFilename
ModelDefinitionMap	myPreloadModelMap
ModelDefinitionMap	myDiscoveredModelMap
ModelSchemaMap	myModelSchemaMap
DtModelPreloadSettingsManager *	mySettingsManager

Friends
class	DtModelPreloadManagerCreator

Detailed Description

DtModelPreloadManager is responsible for managing models to preload and tracking loaded models that were not in the preload list.

Member Typedef Documentation

typedef boost::unordered_set<std::string> makVrv::DtModelPreloadManager::ModelDefinitionMap

typedef boost::unordered_set<std::string> makVrv::DtModelPreloadManager::ModelSchemaMap

Constructor & Destructor Documentation

virtual makVrv::DtModelPreloadManager::~DtModelPreloadManager ( )

virtual

DTOR.

makVrv::DtModelPreloadManager::DtModelPreloadManager ( DtDe &  de )

protected

CTOR.

Member Function Documentation

virtual void makVrv::DtModelPreloadManager::addModelDefinitionToPreloadList ( const std::string &  modelDefName )

virtual

Add the model definition to the preload list.

virtual void makVrv::DtModelPreloadManager::removeModelDefinitionFromPreloadList ( const std::string &  modelDefName )

virtual

Remove the model definition from the preload list.

virtual void makVrv::DtModelPreloadManager::addModelDefinitionToDiscoveredModelList ( const std::string &  modelDefName )

virtual

Add the model definition to the discovered model list.

virtual void makVrv::DtModelPreloadManager::removeModelDefinitionFromDiscoveredModelList ( const std::string &  modelDefName )

virtual

Remove the model definition from the discovered model list.

virtual void makVrv::DtModelPreloadManager::addSchemaToValidList ( const std::string &  schemaName )

virtual

Add schema to the list of valid schema for preloading.

virtual void makVrv::DtModelPreloadManager::removeSchemaFromValidList ( const std::string &  schemaName )

virtual

Remove schema from the list of valid schema for preloading.

virtual bool makVrv::DtModelPreloadManager::isValidModelDefinition ( const std::string &  modelDefName )

virtual

Return true if schema of the model definition is a valid one for preloading.

virtual bool makVrv::DtModelPreloadManager::isValidModelSchema ( const std::string &  schemaName )

virtual

Return true if schema is a valid one for preloading.

const std::string& makVrv::DtModelPreloadManager::preloadFilename

(

)

const

Get the filename containing the model definitions to preload.

virtual void makVrv::DtModelPreloadManager::setPreloadFilename ( const std::string &  filename )

virtual

Set the filename containing the model definitions to preload.

const std::string& makVrv::DtModelPreloadManager::discoveredModelsFilename

(

)

const

Get the filename containing the models loaded that were not in the preload model list.

void makVrv::DtModelPreloadManager::setDiscoveredModelsFilename

(

const std::string &

filename

)

Set the filename containing the models loaded that were not in the preload model list.

virtual void makVrv::DtModelPreloadManager::clearPreloadList ( )

virtual

Clears the preload model list.

virtual void makVrv::DtModelPreloadManager::loadDefaults ( bool  loadOnlyFactorSettings = false )

virtual

Load the default settings.

virtual void makVrv::DtModelPreloadManager::saveAsDefaults ( )

virtual

Called to save the current settings as the default settings.

virtual void makVrv::DtModelPreloadManager::exportSettings ( const std::string &  filename )

virtual

Exports the current settings to a file.

virtual void makVrv::DtModelPreloadManager::exportDiscoveredSettings ( const std::string &  filename )

virtual

Exports the current discovered settings to a file.

virtual void makVrv::DtModelPreloadManager::importSettings ( const std::string &  filename )

virtual

Imports the current settings from a file.

virtual void makVrv::DtModelPreloadManager::mergeSettings ( const std::string &  filename )

virtual

Imports settings from a file merging with the current settings.

virtual DtBackupInterface* makVrv::DtModelPreloadManager::backup ( )

virtual

Get the settings back for the preload model list.

virtual void makVrv::DtModelPreloadManager::setModelPreloadFromRecord ( const makArchives::DtModelPreloadSetRecord &  rec )

virtual

Set the model preload list in the manager from a record.

virtual void makVrv::DtModelPreloadManager::getModelPreloadRecord ( makArchives::DtModelPreloadSetRecord &  rec ) const

virtual

Get a record containing the model preload list in the manager.

virtual void makVrv::DtModelPreloadManager::getDiscoveredModelPreloadRecord ( makArchives::DtModelPreloadSetRecord &  rec ) const

virtual

Get a record containing the model preload list in the manager.

bool makVrv::DtModelPreloadManager::isInPreloadList

(

const std::string &

modelDefName

)

const

Returns true of model is in the model preload list.

virtual bool makVrv::DtModelPreloadManager::preloadModels ( )

virtual

Preload all models in the preload model list.

virtual void makVrv::DtModelPreloadManager::slot_modelCreated ( DtModelInstance &  modelInstance )

virtual

Called when a model instance is created.

virtual void makVrv::DtModelPreloadManager::slot_displayEngineAdded ( const DtDeRecord &  deRec )

virtual

Receives notification that a new De has been connected for propagation of preloaded models display engines.

virtual void makVrv::DtModelPreloadManager::slot_quit ( )

virtual

Receives notification that a new De has been connected.

static DtModelPreloadManager& makVrv::DtModelPreloadManager::instance ( DtDe &  de )

static

Create and register the DtPreloadModelManager.

const ModelDefinitionMap& makVrv::DtModelPreloadManager::preloadModelMap

(

)

const

Get the container of preload models.

void makVrv::DtModelPreloadManager::setSettingsManager

(

DtModelPreloadSettingsManager *

settingsMgr

)

Friends And Related Function Documentation

friend class DtModelPreloadManagerCreator

friend

Member Data Documentation

DtDe& makVrv::DtModelPreloadManager::myDe

protected

DtModelPreloaderAgent* makVrv::DtModelPreloadManager::myAgent

protected

DtMetaFileManager* makVrv::DtModelPreloadManager::myMetaFileManager

protected

std::string makVrv::DtModelPreloadManager::myPreloadModelFilename

protected

std::string makVrv::DtModelPreloadManager::myDiscoveredModelFilename

protected

ModelDefinitionMap makVrv::DtModelPreloadManager::myPreloadModelMap

protected

ModelDefinitionMap makVrv::DtModelPreloadManager::myDiscoveredModelMap

protected

ModelSchemaMap makVrv::DtModelPreloadManager::myModelSchemaMap

protected

DtModelPreloadSettingsManager* makVrv::DtModelPreloadManager::mySettingsManager

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtModelPreloadManager.h