The DtVrfModelSetManager class is the main entry point to find parameter data for objects in the simulation. When the simulation model set is loaded, or, a new simulation model set set on the network, this class will be used to load the simulation model set and all .entity files in all simulation model sets included. It will use the makVrf::DtSharedModelSet class to store the actual information. The shared model set class is used in both the main thread and the network thread to query parameter information for an entity type. You can either use the makVrv::DtReadSettingsLock around the makVrf::DtSharedModelSet to query for information (in the network thread), or, in the main thread, use this class to query the information requested for parameter data.

Related Examples

Inheritance diagram for makVrf::DtVrfModelSetManager:

[legend]

Public Types
typedef boost::function < DtString(const DtVrfObjectParameters *)>	DefaultDescriptionFunciton

Public Member Functions
	DtVrfModelSetManager (makVrv::DtDe &)

virtual	~DtVrfModelSetManager ()

virtual void	setVariableBindings (const DtRwVariableBindings *)

virtual void	setSearchPaths (const DtReaderWriter::SearchPaths &)

virtual bool	load (const std::string &, bool reset=true, bool signal=true)

virtual bool	taskWillNotAbandonPlan (const DtEntityType &key, const DtSimTaskMessageType &taskType) const

virtual QString	parameterTranslation (const DtString &name) const

virtual bool	loadFromDirectory (const std::string &dataDirectory, const std::string &guiDirectory, const std::string &platformsDirectory, bool reset=true, bool signal=true, bool preloadParameters=false)

virtual DtModelSetEntry *	modelSetEntry (const DtEntityMapperKey &key) const

virtual DtRwColor	getDefaultColor (const DtEntityType &) const

virtual bool	canHoldSubordinates (const DtEntityMapperKey &key) const

virtual std::vector< DtFilename >	searchPaths () const

virtual std::vector< DtObjectType >	subordinateObjects (const DtEntityMapperKey &) const

virtual bool	isRandomized (const DtEntityMapperKey &) const

virtual bool	hasComponentDescriptor (const DtEntityMapperKey &, const DtString &type)

virtual void	setSimulationModelSets (const std::vector< DtSimulationModelSet * > &sets)

virtual std::vector < DtSimulationModelSet * >	simulationModelSets () const

virtual DtModelSetEntry *	exactModelSetEntry (const DtEntityMapperKey &key) const

virtual void	getSupportPoints (const DtEntityType &et, DtVector &left, DtVector &right, DtVector &other)

virtual Dt3dBoundingVolume	getBoundingVolume (const DtEntityMapperKey &et)

virtual DtEntityType	nameToType (const DtString &) const

virtual DtFilename	iconForList (const DtEntityType &, const DtString &list) const

virtual bool	isFavorite (const DtEntityMapperKey &key, int force) const

virtual std::set< DtString >	categories () const

virtual DtModelSetEntry *	findByLabel (const DtString &) const

virtual DtModelSetEntry *	addModelSetEntry (const DtString &label, const DtEntityMapperKey &, const DtRwNLengthStringVector &cats)

virtual std::vector< DtString >	taskGroupsForTask (const DtEntityType &key, const DtSimTaskMessageType &) const

virtual void	addSimulationObjectGroupModelSetEntry (DtSimulationObjectGroupModelSetEntry *entry)

virtual DtSimulationObjectGroupModelSetEntry	findSimulationObjectGroup (const std::string &sogName) const

virtual DtObjectType	nextAvailableSimulationObjectGroupObjectType () const

virtual void	removeModelSetEntry (const DtEntityMapperKey &e)

virtual std::string	nameFor (const DtEntityMapperKey &) const

virtual std::string	keywordsFor (const DtEntityMapperKey &) const

virtual bool	canEmbedIntoTerrain (const DtEntityMapperKey &) const

virtual bool	canEmbark (const DtEntityMapperKey &) const

virtual bool	canAttachTo (const DtEntityMapperKey &) const

virtual bool	canEmbarkUpon (const DtEntityMapperKey &) const

virtual bool	organized (const DtEntityMapperKey &) const

virtual int	displayObjectImage (const DtEntityMapperKey &) const

virtual std::string	additionalKeywords (const DtEntityMapperKey &) const

virtual void	setAdditionalKeywords (const DtEntityMapperKey &, const std::string &, bool replace=false)

virtual void	statePropertiesForPlatform (const DtString &, DtRwProperties &) const

virtual void	parameterPropertiesForPlatform (const DtString &, DtRwProperties &) const

virtual void	statePropertiesFor (const DtEntityType &, DtRwProperties &) const

virtual void	parameterPropertiesFor (const DtEntityType &, DtRwProperties &)

template<class T >
boost::optional< T >	parameterPropertyFor (const DtEntityMapperKey &e, const std::string &propertyName) const

virtual DtString	defaultDescriptionFor (const DtEntityType &) const

virtual DtString	defaultDescriptionFor (const DtVrfObjectParameters *) const

virtual DtString	systemDescriptionFor (const DtVrfObjectParameters *, const DtString &systemCategory) const

virtual void	setDefaultDescriptionProvider (const DtString &parameterType, DefaultDescriptionFunciton)

virtual DtString	defaultDescriptionFunction (const DtVrfObjectParameters *) const

virtual void	setModelSet (DtModelSet *)

virtual void	setFavorite (const DtEntityMapperKey &key, bool b)

virtual DtModelSet *	loadFavoritesFor (const std::string &)

virtual void	mergeFavoritesInto (DtModelSet favorite, DtModelSet modelSet)

virtual void	mergeFavorites (DtModelSet *favorites)

virtual DtModelSetEntry *	favoriteFor (DtModelSetEntry *) const

virtual DtModelSet *	modelSet ()

virtual DtModelSet	modelSet () const

virtual DtRwVisualMetaData	visualMetaData (const DtEntityType &)

void	setAutoSave (bool b)

bool	autoSave () const

virtual DtSharedModelSet::EquipmentTypeMap	baseEquipment (const DtObjectType &)

virtual bool	load (const DtScenarioExplorer &, bool=true)

virtual void	initializeCountries ()

virtual void	setTags (const DtSimulationObjectCategoryInformation &)

const DtSimulationObjectCategoryInformation &	tags () const

Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()

virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtVrfModelSetManager &	instance (makVrv::DtDe &de)

static void	registerInstance (makVrv::DtDe &de, DtVrfModelSetManager *messager)

Public Attributes
boost::signals2::signal< void()>	signal_tagsSet

boost::signals2::signal< void()>	signal_modelSetChanged

Protected Types
typedef std::map< std::string, DtModelSet * >	Favorites

typedef std::map< std::string, DefaultDescriptionFunciton >	DefaultDescriptionFuncitons

Protected Member Functions
virtual void	clearModelSets ()

virtual DtString	systemDescriptionFor (const DtComponentSystemDescriptorList &, const DtString &systemCategory) const

virtual DtString	systemDescriptionFor (const DtComponentSystemDescriptor *, const DtString &systemCategory) const

Protected Attributes
makVrv::DtDe &	myDe

bool	myAutoSave

Favorites	myFavorites

DtModelSet *	myModelSet

DefaultDescriptionFuncitons	myDefaultDescriptionFunctions

makVrv::DtSignalConnectionManager	myConnectionManager

DtSimulationObjectCategoryInformation	myTags

Member Typedef Documentation

typedef boost::function<DtString (const DtVrfObjectParameters*)> makVrf::DtVrfModelSetManager::DefaultDescriptionFunciton

typedef std::map<std::string, DtModelSet*> makVrf::DtVrfModelSetManager::Favorites

protected

typedef std::map<std::string, DefaultDescriptionFunciton> makVrf::DtVrfModelSetManager::DefaultDescriptionFuncitons

protected

Constructor & Destructor Documentation

makVrf::DtVrfModelSetManager::DtVrfModelSetManager ( makVrv::DtDe & )

virtual makVrf::DtVrfModelSetManager::~DtVrfModelSetManager ( )

virtual

Member Function Documentation

static DtVrfModelSetManager& makVrf::DtVrfModelSetManager::instance ( makVrv::DtDe & de )

static

Returns instance of the messager.

Referenced by makVrf::DtSetStatePropertyDialog::setupGui().

static void makVrf::DtVrfModelSetManager::registerInstance	(	makVrv::DtDe &	de,
		DtVrfModelSetManager *	messager
	)

static

virtual void makVrf::DtVrfModelSetManager::setVariableBindings ( const DtRwVariableBindings * )

virtual

Sets variable bindings to be used for future reads of the platforms and files. This will call down to the shared model set to set, so use that class to retrieve.

virtual void makVrf::DtVrfModelSetManager::setSearchPaths ( const DtReaderWriter::SearchPaths & )

virtual

And the search paths to use for entity file loads. This will call down to the shared model set to set, so, use that class (with appropriate locking) to retrieve.

virtual bool makVrf::DtVrfModelSetManager::load	(	const std::string &	,
		bool	reset = `true`,
		bool	signal = `true`
	)

virtual

Loads model set file into model set and then signals loaded if successful.

virtual bool makVrf::DtVrfModelSetManager::taskWillNotAbandonPlan	(	const DtEntityType &	key,
		const DtSimTaskMessageType &	taskType
	)		const

virtual

Returns true if this task will not abandon a currently running plan.

virtual QString makVrf::DtVrfModelSetManager::parameterTranslation ( const DtString & name ) const

virtual

Returns the parameter name (from state or parameter data) translated.

virtual bool makVrf::DtVrfModelSetManager::loadFromDirectory	(	const std::string &	dataDirectory,
		const std::string &	guiDirectory,
		const std::string &	platformsDirectory,
		bool	reset = `true`,
		bool	signal = `true`,
		bool	preloadParameters = `false`
	)

virtual

Loads the model set from the specified directory. This will scan for all .data files. The gui directory is needed for favorites.

virtual DtModelSetEntry* makVrf::DtVrfModelSetManager::modelSetEntry ( const DtEntityMapperKey & key ) const

virtual

Find exactly or by matching pattern.

virtual DtRwColor makVrf::DtVrfModelSetManager::getDefaultColor ( const DtEntityType & ) const

virtual

By tags from the model set entry, gets the default color (if available) for the object.

virtual bool makVrf::DtVrfModelSetManager::canHoldSubordinates ( const DtEntityMapperKey & key ) const

virtual

Returns true if the given type has the ability to contain subordinates.

virtual std::vector<DtFilename> makVrf::DtVrfModelSetManager::searchPaths ( ) const

virtual

The search paths used by the shared model set to load the parameter database.

virtual std::vector<DtObjectType> makVrf::DtVrfModelSetManager::subordinateObjects ( const DtEntityMapperKey & ) const

virtual

Returns the subodrinate objects of this model set entry.

virtual bool makVrf::DtVrfModelSetManager::isRandomized ( const DtEntityMapperKey & ) const

virtual

Returns true if this is a randomized model.

virtual bool makVrf::DtVrfModelSetManager::hasComponentDescriptor	(	const DtEntityMapperKey &	,
		const DtString &	type
	)

virtual

Returns true if there are any component descriptors of the given types available.

virtual void makVrf::DtVrfModelSetManager::setSimulationModelSets ( const std::vector< DtSimulationModelSet * > & sets )

virtual

Calls down to shared model set manager.

virtual std::vector<DtSimulationModelSet*> makVrf::DtVrfModelSetManager::simulationModelSets ( ) const

virtual

virtual DtModelSetEntry* makVrf::DtVrfModelSetManager::exactModelSetEntry ( const DtEntityMapperKey & key ) const

virtual

Find exactly only.

virtual void makVrf::DtVrfModelSetManager::getSupportPoints	(	const DtEntityType &	et,
		DtVector &	left,
		DtVector &	right,
		DtVector &	other
	)

virtual

Gets the support points of the object.

virtual Dt3dBoundingVolume makVrf::DtVrfModelSetManager::getBoundingVolume ( const DtEntityMapperKey & et )

virtual

Returns the bounding volume of the given entity.

virtual DtEntityType makVrf::DtVrfModelSetManager::nameToType ( const DtString & ) const

virtual

Give a label return the entity type that has an exact match (case included) for that label.

virtual DtFilename makVrf::DtVrfModelSetManager::iconForList	(	const DtEntityType &	,
		const DtString &	list
	)		const

virtual

Returns the path for the icon for the icon list for the entity type if it exists.

virtual bool makVrf::DtVrfModelSetManager::isFavorite	(	const DtEntityMapperKey &	key,
		int	force
	)		const

virtual

Returns true if the item/force combination is a favorite.

virtual std::set<DtString> makVrf::DtVrfModelSetManager::categories ( ) const

virtual

Returns all the categories contained in this model set.

virtual DtModelSetEntry* makVrf::DtVrfModelSetManager::findByLabel ( const DtString & ) const

virtual

Return the model set entry (if it exists) by the given label.

virtual DtModelSetEntry* makVrf::DtVrfModelSetManager::addModelSetEntry	(	const DtString &	label,
		const DtEntityMapperKey &	,
		const DtRwNLengthStringVector &	cats
	)

virtual

Add a new model set entry.

virtual std::vector<DtString> makVrf::DtVrfModelSetManager::taskGroupsForTask	(	const DtEntityType &	key,
		const DtSimTaskMessageType &
	)		const

virtual

Looks up the task exclusion rules for the given entity and returns them.

virtual void makVrf::DtVrfModelSetManager::addSimulationObjectGroupModelSetEntry ( DtSimulationObjectGroupModelSetEntry * entry )

virtual

Adds a new simulation object group model set entry. Will take ownership of this passed in memory so do not delete. If entry does not have a valid simulation object group object type will assign it.

virtual DtSimulationObjectGroupModelSetEntry makVrf::DtVrfModelSetManager::findSimulationObjectGroup ( const std::string & sogName ) const

virtual

Returns the entry that has a filename which references the given simulation object group.

virtual DtObjectType makVrf::DtVrfModelSetManager::nextAvailableSimulationObjectGroupObjectType ( ) const

virtual

Returns the next object typ that can be used for the simulaton object group model set entry.

virtual void makVrf::DtVrfModelSetManager::removeModelSetEntry ( const DtEntityMapperKey & e )

virtual

Removes the model set entry.

virtual std::string makVrf::DtVrfModelSetManager::nameFor ( const DtEntityMapperKey & ) const

virtual

Returns the name of the item. Blank if none.

virtual std::string makVrf::DtVrfModelSetManager::keywordsFor ( const DtEntityMapperKey & ) const

virtual

Returns the keywords of the item. Blank if none.

virtual bool makVrf::DtVrfModelSetManager::canEmbedIntoTerrain ( const DtEntityMapperKey & ) const

virtual

Returns true if this entity can embed into the terrain.

virtual bool makVrf::DtVrfModelSetManager::canEmbark ( const DtEntityMapperKey & ) const

virtual

Returns true if this entity can embark.

virtual bool makVrf::DtVrfModelSetManager::canAttachTo ( const DtEntityMapperKey & ) const

virtual

Returns true if this entity can be attached to. By default only kind < 11 can be attached to.

virtual bool makVrf::DtVrfModelSetManager::canEmbarkUpon ( const DtEntityMapperKey & ) const

virtual

Returns true if this entity can be embarked upon.

virtual bool makVrf::DtVrfModelSetManager::organized ( const DtEntityMapperKey & ) const

virtual

Returns whether or not this item is organized by default.

virtual int makVrf::DtVrfModelSetManager::displayObjectImage ( const DtEntityMapperKey & ) const

virtual

Returns how to display the object image in the palette.

virtual std::string makVrf::DtVrfModelSetManager::additionalKeywords ( const DtEntityMapperKey & ) const

virtual

Set/get additional keywords that will be used with the given entity mapper key (exact match). If replace is false then the keywords will be appended to the current keywords.

virtual void makVrf::DtVrfModelSetManager::setAdditionalKeywords	(	const DtEntityMapperKey &	,
		const std::string &	,
		bool	replace = `false`
	)

virtual

virtual void makVrf::DtVrfModelSetManager::statePropertiesForPlatform	(	const DtString &	,
		DtRwProperties &
	)		const

virtual

Returns a copy of the state properties for the given platform, if it exists.

Referenced by makVrf::DtSetStatePropertyDialog::setupGui().

virtual void makVrf::DtVrfModelSetManager::parameterPropertiesForPlatform	(	const DtString &	,
		DtRwProperties &
	)		const

virtual

Returns a copy of the parameter properties for the given platform, if it exists.

Referenced by makVrf::DtSetStatePropertyDialog::setupGui().

virtual void makVrf::DtVrfModelSetManager::statePropertiesFor	(	const DtEntityType &	,
		DtRwProperties &
	)		const

virtual

If there are state properties in the .ope file referenced by this entity, return them.

Referenced by makVrf::DtSetStatePropertyDialog::setupGui().

virtual void makVrf::DtVrfModelSetManager::parameterPropertiesFor	(	const DtEntityType &	,
		DtRwProperties &
	)

virtual

If there is parameter properties in the .ope file referenced by this entity, return them.

Referenced by makVrf::DtSetStatePropertyDialog::setupGui().

template<class T >

boost::optional<T> makVrf::DtVrfModelSetManager::parameterPropertyFor	(	const DtEntityMapperKey &	e,
		const std::string &	propertyName
	)		const

inline

Returns the parameter property for the given entity type and property name. Return NULL object if property does not exist.

References makVrv::DtSharedSettingsManager::instance().

virtual DtString makVrf::DtVrfModelSetManager::defaultDescriptionFor ( const DtEntityType & ) const

virtual

Given an entity type, return a default description for that entity type. The default description is based upon the object parameter type (i.e. fixed-wing-entity-param) and as registered in the setDefaultDescriptionProvider method.

virtual DtString makVrf::DtVrfModelSetManager::defaultDescriptionFor ( const DtVrfObjectParameters * ) const

virtual

virtual DtString makVrf::DtVrfModelSetManager::systemDescriptionFor	(	const DtVrfObjectParameters *	,
		const DtString &	systemCategory
	)		const

virtual

If the object parameter has a particular system category then return the first description found for that category.

virtual void makVrf::DtVrfModelSetManager::setDefaultDescriptionProvider	(	const DtString &	parameterType,
		DefaultDescriptionFunciton
	)

virtual

virtual DtString makVrf::DtVrfModelSetManager::defaultDescriptionFunction ( const DtVrfObjectParameters * ) const

virtual

If there is no mapping for a description, this method is used by default.

virtual void makVrf::DtVrfModelSetManager::setModelSet ( DtModelSet * )

virtual

Deletes current model set (if owned) and sets new model set. Does not take ownership.

virtual void makVrf::DtVrfModelSetManager::setFavorite	(	const DtEntityMapperKey &	key,
		bool	b
	)

virtual

Sets the model set entry that matches the mapper key to be a favorite. If auto-save is true also saves out the model set file.

virtual DtModelSet* makVrf::DtVrfModelSetManager::loadFavoritesFor ( const std::string & )

virtual

Loads the favorites file for the given model set file. Assumes there is a file called favorites.mst in the ame directory referenced for the entity.mst file.

virtual void makVrf::DtVrfModelSetManager::mergeFavoritesInto	(	DtModelSet *	favorite,
		DtModelSet *	modelSet
	)

virtual

Merges the favorites selection into the given model set. If there are no matching types no merge will occur for that type.

virtual void makVrf::DtVrfModelSetManager::mergeFavorites ( DtModelSet * favorites )

virtual

Merge favorites into the shared model set.

virtual DtModelSetEntry* makVrf::DtVrfModelSetManager::favoriteFor ( DtModelSetEntry * ) const

virtual

Returns the favorite that matched the model set entry.

virtual DtModelSet* makVrf::DtVrfModelSetManager::modelSet ( )

virtual

Returns a model set created from the shared model set.

virtual DtModelSet makVrf::DtVrfModelSetManager::modelSet ( ) const

virtual

Returns a copy of the model set.

virtual DtRwVisualMetaData makVrf::DtVrfModelSetManager::visualMetaData ( const DtEntityType & )

virtual

Visual meta data for the given entity type.

Reimplemented in DtSimulationModelSetManager.

void makVrf::DtVrfModelSetManager::setAutoSave ( bool b )

inline

bool makVrf::DtVrfModelSetManager::autoSave ( ) const

inline

virtual DtSharedModelSet::EquipmentTypeMap makVrf::DtVrfModelSetManager::baseEquipment ( const DtObjectType & )

virtual

Given a particular entity type, return all the Base-Primary-Equipment that the given entity type pattern has.

virtual bool makVrf::DtVrfModelSetManager::load	(	const DtScenarioExplorer &	,
		bool	= `true`
	)

virtual

Loads all the model sets from the scenario explorer.

virtual void makVrf::DtVrfModelSetManager::initializeCountries ( )

virtual

Reinitializes countries and adds any countries that are not present in the country list.

virtual void makVrf::DtVrfModelSetManager::setTags ( const DtSimulationObjectCategoryInformation & )

virtual

const DtSimulationObjectCategoryInformation& makVrf::DtVrfModelSetManager::tags ( ) const

inline

virtual void makVrf::DtVrfModelSetManager::clearModelSets ( )

protectedvirtual

Clears out all loaded model sets.

virtual DtString makVrf::DtVrfModelSetManager::systemDescriptionFor	(	const DtComponentSystemDescriptorList &	,
		const DtString &	systemCategory
	)		const

protectedvirtual

If the object parameter has a particular system category then return the first description found for that category.

virtual DtString makVrf::DtVrfModelSetManager::systemDescriptionFor	(	const DtComponentSystemDescriptor *	,
		const DtString &	systemCategory
	)		const

protectedvirtual

Member Data Documentation

boost::signals2::signal<void ()> makVrf::DtVrfModelSetManager::signal_tagsSet

boost::signals2::signal<void ()> makVrf::DtVrfModelSetManager::signal_modelSetChanged

makVrv::DtDe& makVrf::DtVrfModelSetManager::myDe

protected

bool makVrf::DtVrfModelSetManager::myAutoSave

protected

Favorites makVrf::DtVrfModelSetManager::myFavorites

protected

DtModelSet* makVrf::DtVrfModelSetManager::myModelSet

protected

DefaultDescriptionFuncitons makVrf::DtVrfModelSetManager::myDefaultDescriptionFunctions

protected

makVrv::DtSignalConnectionManager makVrf::DtVrfModelSetManager::myConnectionManager

protected

DtSimulationObjectCategoryInformation makVrf::DtVrfModelSetManager::myTags

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfGuiCore/vrfModelSetManager.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation