Shared information about the current model set and entities/platforms that are available to it. More...

Inheritance diagram for makVrf::DtSharedModelSet:

Classes
class	AdditionalKey
struct	PlatformStruct

Public Member Functions
virtual	~DtSharedModelSet ()
	DTOR.
virtual void	setModelSet (DtModelSet *)
	Sets the model set into this manager. Replaces existing model set.
virtual void	clearModelSet ()
	Creates a new model set.
virtual bool	load (const DtFilename &, bool signal=false)
	Loads model set from file.
virtual void	addSimulationObjectGroupModelSetEntry (DtSimulationObjectGroupModelSetEntry *entry)
	Adds a new simulation object group model set entry.
virtual DtSimulationObjectGroupModelSetEntry	findSimulationObjectGroup (const std::string &sogName) const
	Returns the entry that has a filename which references the given simulation object group.
virtual void	getSupportPoints (const DtEntityType &et, DtVector &left, DtVector &right, DtVector &other)
	Gets the support points of the object.
virtual std::string	getNavDataPath (const DtEntityType &et)
virtual Dt3dBoundingVolume	getBoundingVolume (const DtEntityMapperKey &et)
	Returns the bounding volume of the given entity.
virtual bool	loadFromDataFiles (const DtFilename &entities, const DtFilename &platforms, bool signal=true)
	Loads models from data files in given directory for entities and platforms.
virtual void	mergeFavorites (const DtModelSet *f)
	Merges favorites into this model set.
virtual DtEntityType	nameToType (const DtString &) const
	Give a label return the entity type that has an exact match (case included) for that label.
virtual DtModelSetEntry *	modelSetEntry (const DtEntityMapperKey &key) const
	Find exactly or by matching pattern.
virtual std::string	additionalKeywords (const DtEntityMapperKey &) const
	Set/get additional keywords that will be used with the given entity mapper key (exact match).
virtual void	setAdditionalKeywords (const DtEntityMapperKey &, const std::string &, bool replace=false)
virtual DtModelSetEntry *	exactModelSetEntry (const DtEntityMapperKey &key) const
	Find exactly only.
virtual bool	canHoldSubordinates (const DtEntityMapperKey &key) const
	Returns true if the given type has the ability to contain subordinates.
virtual DtModelSetEntry *	addModelSetEntry (const DtString &label, const DtEntityMapperKey &, const DtRwNLengthStringVector &cats)
	Add a new model set entry.
virtual void	removeModelSetEntry (const DtEntityMapperKey &e)
	Removes the model set entry.
virtual std::string	nameFor (const DtEntityMapperKey &) const
	Returns the name of the item. Blank if none.
virtual std::string	keywordsFor (const DtEntityMapperKey &) const
	Returns the keywords of the item. Blank if none.
virtual DtModelSet *	modelSet () const
	Returns the model set.
virtual void	statePropertiesFor (const DtEntityType &, DtRwProperties &) const
	If there are state properties in the .ope file referenced by this entity, return them.
virtual void	parameterPropertiesFor (const DtEntityType &, DtRwProperties &)
	If there is parameter properties in the .ope file referenced by this entity, return them.
virtual void	parameterPropertiesFor (const std::set< const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > * > &states, DtRwProperties &)
	Given the states, return a total of all the parameter properties for numerical items found within.
virtual boost::shared_ptr < DtReaderWriter >	rwProperty (const DtEntityType &, const std::string &prop) const
	Returns the property for the given item.
virtual void	loadPlatforms (const DtString &)
	Loads platforms from the given directory.
virtual void	clearPlatforms ()
	Clears out all platforms.
virtual DtRwDIGuyCharacterInfo	getDIGuyCharacterInformation (const DtEntityMapperKey &)
	Gets the DI Guy Character information (if it exists) for the specified entity.
virtual DtVrfObjectParameters *	lookupParametersFor (DtModelSetEntry *entry)
	Looks up parameter entry.
virtual DtObjectType	nextAvailableSimulationObjectGroupObjectType () const
	Returns the next object typ that can be used for the simulaton object group model set entry.
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR.
virtual	~DtSharedSettings ()
	DTOR.
boost::shared_mutex &	mutex ()
	Get the mutex for the settings object.
SafetyKey	safeToEmitSignals ()
	Create a safety key for the function, see above example.
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
	No need to call, set by the DtWriteSettingLock object.
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static std::string	className ()
	Get an instance of the settings object.

Protected Types
typedef std::map< std::string, boost::shared_ptr < DtReaderWriter > >	PropertiesMap
typedef std::map< DtString, PlatformStruct >	PlatformsMap
typedef std::map < DtModelSetEntry , DtVrfObjectParameters >	ParameterData
typedef DtOrderedKeyList < AdditionalKey * >	AdditionalKeywords

Protected Member Functions
	DtSharedModelSet (makVrv::DtSharedSettingsManager &)

Protected Attributes
DtModelSet *	myModelSet
PlatformsMap	myAvailablePlatforms
ParameterData	myParameterData
	Parameter data is mutable so that we can cache retrieved data in paramegerDataFor().
DtReaderWriter::SearchPaths	mySearchPaths
AdditionalKeywords	myAdditionalKeywords

Friends
class	makVrv::DtReadSettingsLock< DtSharedModelSet >
	Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.
class	makVrv::DtWriteSettingsLock< DtSharedModelSet >
class	makVrv::DtSharedSettingsManager

Detailed Description

Shared information about the current model set and entities/platforms that are available to it.

Member Typedef Documentation

typedef std::map<std::string, boost::shared_ptr<DtReaderWriter> > makVrf::DtSharedModelSet::PropertiesMap

protected

typedef std::map<DtString, PlatformStruct> makVrf::DtSharedModelSet::PlatformsMap

protected

typedef std::map<DtModelSetEntry*, DtVrfObjectParameters*> makVrf::DtSharedModelSet::ParameterData

protected

typedef DtOrderedKeyList<AdditionalKey*> makVrf::DtSharedModelSet::AdditionalKeywords

protected

Constructor & Destructor Documentation

virtual makVrf::DtSharedModelSet::~DtSharedModelSet ( )

virtual

DTOR.

makVrf::DtSharedModelSet::DtSharedModelSet ( makVrv::DtSharedSettingsManager & )

protected

Member Function Documentation

static std::string makVrf::DtSharedModelSet::className ( )

static

Get an instance of the settings object.

Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

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

virtual

Sets the model set into this manager. Replaces existing model set.

virtual void makVrf::DtSharedModelSet::clearModelSet ( )

virtual

Creates a new model set.

virtual bool makVrf::DtSharedModelSet::load	(	const DtFilename &	,
		bool	signal = `false`
	)

virtual

Loads model set from file.

virtual void makVrf::DtSharedModelSet::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::DtSharedModelSet::findSimulationObjectGroup ( const std::string & sogName ) const

virtual

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

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

virtual

Gets the support points of the object.

virtual std::string makVrf::DtSharedModelSet::getNavDataPath ( const DtEntityType & et )

virtual

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

virtual

Returns the bounding volume of the given entity.

virtual bool makVrf::DtSharedModelSet::loadFromDataFiles	(	const DtFilename &	entities,
		const DtFilename &	platforms,
		bool	signal = `true`
	)

virtual

Loads models from data files in given directory for entities and platforms.

virtual void makVrf::DtSharedModelSet::mergeFavorites ( const DtModelSet * f )

virtual

Merges favorites into this model set.

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

virtual

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

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

virtual

Find exactly or by matching pattern.

virtual std::string makVrf::DtSharedModelSet::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::DtSharedModelSet::setAdditionalKeywords	(	const DtEntityMapperKey &	,
		const std::string &	,
		bool	replace = `false`
	)

virtual

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

virtual

Find exactly only.

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

virtual

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

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

virtual

Add a new model set entry.

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

virtual

Removes the model set entry.

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

virtual

Returns the name of the item. Blank if none.

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

virtual

Returns the keywords of the item. Blank if none.

virtual DtModelSet* makVrf::DtSharedModelSet::modelSet ( ) const

virtual

Returns the model set.

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

virtual

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

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

virtual

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

virtual void makVrf::DtSharedModelSet::parameterPropertiesFor	(	const std::set< const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > * > &	states,
		DtRwProperties &
	)

virtual

Given the states, return a total of all the parameter properties for numerical items found within.

Boolean and string values that have the same value will be kept. Those that have differing values will be marked as read only

virtual boost::shared_ptr<DtReaderWriter> makVrf::DtSharedModelSet::rwProperty	(	const DtEntityType &	,
		const std::string &	prop
	)		const

virtual

Returns the property for the given item.

virtual void makVrf::DtSharedModelSet::loadPlatforms ( const DtString & )

virtual

Loads platforms from the given directory.

virtual void makVrf::DtSharedModelSet::clearPlatforms ( )

virtual

Clears out all platforms.

virtual DtRwDIGuyCharacterInfo makVrf::DtSharedModelSet::getDIGuyCharacterInformation ( const DtEntityMapperKey & )

virtual

Gets the DI Guy Character information (if it exists) for the specified entity.

virtual DtVrfObjectParameters* makVrf::DtSharedModelSet::lookupParametersFor ( DtModelSetEntry * entry )

virtual

Looks up parameter entry.

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

virtual

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

Friends And Related Function Documentation

friend class makVrv::DtReadSettingsLock< DtSharedModelSet >

friend

Also protected, use the DtReadSettingsLock and DtWriteSettingsLock to access the object.

friend class makVrv::DtWriteSettingsLock< DtSharedModelSet >

friend

friend class makVrv::DtSharedSettingsManager

friend

Member Data Documentation

DtModelSet* makVrf::DtSharedModelSet::myModelSet

protected

PlatformsMap makVrf::DtSharedModelSet::myAvailablePlatforms

protected

ParameterData makVrf::DtSharedModelSet::myParameterData

protected

Parameter data is mutable so that we can cache retrieved data in paramegerDataFor().

DtReaderWriter::SearchPaths makVrf::DtSharedModelSet::mySearchPaths

protected

AdditionalKeywords makVrf::DtSharedModelSet::myAdditionalKeywords

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/sharedModelSet.h

Classes

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation