makVrf::DtVrfStateViewCollectionManager Class Reference

This class is the central point for looking up information about a particular object in the VRF GUI. More...

Inheritance diagram for makVrf::DtVrfStateViewCollectionManager:

List of all members.

Public Types
typedef std::vector < makVrv::DtSimEntryUpdater::UpdateRate >	UpdateRates
Public Member Functions
	DtVrfStateViewCollectionManager (makVrv::DtDe &)
virtual	~DtVrfStateViewCollectionManager ()
makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	findStateView (const std::string &markingText)
	Returns state view given the marking text. If does not exist, then, will return NULL.
makVrv::DtStateView < DtSpotReportState > *	findSpotReportStateView (const std::string &markingText)
	Returns spot report state view given the marking text. If does not exist, then, will return NULL.
makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	findStateView (const makVrv::DtUniqueID &id)
	Finds a state view given the objects element id.
makVrv::DtStateView < DtSpotReportState > *	findSpotReportStateView (const makVrv::DtUniqueID &id)
	Finds a spot report state view given the objects element id.
makVrv::DtUniqueID	parentId (const makVrv::DtUniqueID &) const
	If this item has a parent (for example, a vertex) return that, else return the passed in id.
makVrv::DtUniqueID	displayIdFromSimId (const makVrv::DtUniqueID &id, int modelSet=-1) const
makVrv::DtElementData::SceneObjectIdList	displayIdsFromSimId (const makVrv::DtUniqueID &id, int modelSet=-1) const
makVrv::DtUniqueID	simIdFromDisplayId (const makVrv::DtUniqueID &id) const
	Returns the name of the object given the specified id.
virtual std::string	entityName (const makVrv::DtUniqueID simId) const
	Returns an entity name based on the simulation id.
virtual std::string	overlayName (const makVrv::DtUniqueID simId) const
	Returns the name of the overlay this item is on (if it is). Pass in element id.
virtual makVrv::DtElementEntry::ElementType	elementType (const makVrv::DtElementID &) const
	Returns the type of the element.
virtual makVrv::DtSimEntryUpdater::UpdateRate	updateRateFor (const makVrv::DtBaseStateView *state) const
	Returns the minimum update rate for the given state view.
virtual makVrv::DtSimEntryUpdater::UpdateRate	minimumRate (const UpdateRates &) const
virtual makVrv::DtSimEntryUpdater::UpdateRate	maximumRate (const UpdateRates &) const
virtual void	setUpdateRate (makVrv::DtSimEntry *, makVrv::DtSimEntryUpdater::UpdateRate, makVrv::DtBaseStateView *state)
	Keeps track of update rates made for a state view.
Data Interface Lookup Methods
These methods return DtObjectDataInterface subclasses specialized to the type of object that is found. The DtObjectDataInterface return values may be cast to their specific types, using DtObjectDataInterface::cast() function. Note: The returned DtObjectDataInterface will remain valid even if the object it refers to is deleted, however, calls to retrieve information about that object will return default values, and DtObjectDataInterface::hasBeenRemoved() will return true. DtObjectDataInterface instances are created when returned from these methods, so shared pointers are used to return them. Shared pointer casting must be used to cast them to a subclass.
virtual DtBoost::shared_ptr < DtObjectDataInterface >	lookupObjectData (const makVrv::DtUniqueID &id)
virtual DtBoost::shared_ptr < DtObjectDataInterface >	lookupSpotReportData (const makVrv::DtUniqueID &id)
virtual DtBoost::shared_ptr < DtObjectDataInterface >	lookupObjectData (const std::string &name)
virtual DtBoost::shared_ptr < DtObjectDataInterface >	lookupSpotReportData (const std::string &name)
template<typename T_ObjectDataInterfaceType >
DtBoost::shared_ptr < T_ObjectDataInterfaceType >	lookupAndCastObjectData (const makVrv::DtUniqueID &id)
template<typename T_ObjectDataInterfaceType >
DtBoost::shared_ptr < T_ObjectDataInterfaceType >	lookupAndCastSpotReportData (const makVrv::DtUniqueID &id)
template<typename T_ObjectDataInterfaceType >
DtBoost::shared_ptr < T_ObjectDataInterfaceType >	lookupAndCastObjectData (const std::string &name)
template<typename T_ObjectDataInterfaceType >
DtBoost::shared_ptr < T_ObjectDataInterfaceType >	lookupAndCastSpotReportData (const std::string &name)
virtual DtBoost::shared_ptr < DtObjectDataInterface >	lookupObjectData (makVrv::DtStateView< makVrv::DtSimState > *stateView)
DtVrfSimulatedEntityStateViewCollection *	simulatedEntityStateViewCollection ()
DtVrlinkSimulatedBaseStateViewCollection *	simulatedBaseStateViewCollection ()
DtVrfObjectDataStateViewCollection *	objectDataStateViewCollection ()
DtEnvironmentStateViewCollection *	environmentStateViewCollection ()
DtExtendedStateDataViewCollection *	extendedStateDataViewCollection ()
DtIffStateDataViewCollection *	iffStateDataViewCollection ()
DtSpotReportStateViewCollection *	spotReportStateViewCollection ()
DtAggregateStateViewCollection *	aggregateStateViewCollection ()
Static Public Member Functions
static DtVrfStateViewCollectionManager &	instance (makVrv::DtDe &de)
Protected Types
typedef boost::unordered_map < makVrv::DtBaseStateView *, UpdateRates >	UpdateRateMap
Protected Attributes
DtVrfSimulatedEntityStateViewCollection *	mySimulatedEntityStateView
DtVrlinkSimulatedBaseStateViewCollection *	mySimulatedBaseStateViewCollection
DtVrfObjectDataStateViewCollection *	myObjectDataStateViewCollection
DtEnvironmentStateViewCollection *	myEnvironmentStateViewCollection
DtSpotReportStateViewCollection *	mySpotReportStateViewCollection
DtAggregateStateViewCollection *	myAggregateStateViewCollection
DtExtendedStateDataViewCollection *	myExtendedStateDataViewCollection
DtIffStateDataViewCollection *	myIffStateDataViewCollection
makVrv::DtDe &	myDe
UpdateRateMap	myUpdateRateMap

---

Detailed Description

This class is the central point for looking up information about a particular object in the VRF GUI.

This class returns both DtStateView and DtObjectDataInterface classes, which contain data about the objects in the system.

DtObjectDataInterface objects provide the higher level interface for interacting with the objects and accessing the data. U Use the lookupObjectData() method below, supplying either scene id, element id or marking text. A DtObjectDataInterface class will be returned, and, the type() method will let you know what type of item it is so you can cast to the appropriate class. For more information please see the DtObjectDataInterface header file which contains the interface class or the specific DtNetworkData<type> class that contains specific methods.

Related Examples

• GUI Object Data Interface example.
• GUI Local Create Object example.

---

Member Typedef Documentation

typedef std::vector<makVrv::DtSimEntryUpdater::UpdateRate> makVrf::DtVrfStateViewCollectionManager::UpdateRates

typedef boost::unordered_map<makVrv::DtBaseStateView*, UpdateRates> makVrf::DtVrfStateViewCollectionManager::UpdateRateMap [protected]

---

Constructor & Destructor Documentation

makVrf::DtVrfStateViewCollectionManager::DtVrfStateViewCollectionManager

(

makVrv::DtDe &

)

virtual makVrf::DtVrfStateViewCollectionManager::~DtVrfStateViewCollectionManager

(

)

[virtual]

---

Member Function Documentation

static DtVrfStateViewCollectionManager& makVrf::DtVrfStateViewCollectionManager::instance

(

makVrv::DtDe &

de

)

[static]

virtual DtBoost::shared_ptr<DtObjectDataInterface> makVrf::DtVrfStateViewCollectionManager::lookupObjectData

(

const makVrv::DtUniqueID &

id

)

[virtual]

Returns:

A DtObjectDataInterface subclass for a particular object in the system.

Parameters:

id	May be a sceneID or an elementID.

virtual DtBoost::shared_ptr<DtObjectDataInterface> makVrf::DtVrfStateViewCollectionManager::lookupSpotReportData

(

const makVrv::DtUniqueID &

id

)

[virtual]

Returns:

A DtObjectDataInterface subclass for the spot report data on a particular object in the system.

Parameters:

id	May be a sceneID or an elementID of the entity or object.

virtual DtBoost::shared_ptr<DtObjectDataInterface> makVrf::DtVrfStateViewCollectionManager::lookupObjectData

(

const std::string &

name

)

[virtual]

Returns:

A DtObjectDataInterface subclass for a particular object in the system.

Parameters:

name	The entity or object name (same as Marking Text).

virtual DtBoost::shared_ptr<DtObjectDataInterface> makVrf::DtVrfStateViewCollectionManager::lookupSpotReportData

(

const std::string &

name

)

[virtual]

Returns:

A DtObjectDataInterface subclass for the spot report data on a particular object in the system.

Parameters:

name	The entity or object name (same as Marking Text).

template<typename T_ObjectDataInterfaceType >

DtBoost::shared_ptr<T_ObjectDataInterfaceType> makVrf::DtVrfStateViewCollectionManager::lookupAndCastObjectData

(

const makVrv::DtUniqueID &

id

)

[inline]

Returns:

A DtObjectDataInterface subclass for a particular object in the system.

Parameters:

id	May be a sceneID or an elementID. This templated method also dynamic-casts the result to the specified DtObjectDataInterface subclass specified.

template<typename T_ObjectDataInterfaceType >

DtBoost::shared_ptr<T_ObjectDataInterfaceType> makVrf::DtVrfStateViewCollectionManager::lookupAndCastSpotReportData

(

const makVrv::DtUniqueID &

id

)

[inline]

Returns:

A DtObjectDataInterface subclass for the spot report data on a particular object in the system.

Parameters:

id	May be a sceneID or an elementID of the entity or object. This templated method also dynamic-casts the result to the specified DtObjectDataInterface subclass specified.

template<typename T_ObjectDataInterfaceType >

DtBoost::shared_ptr<T_ObjectDataInterfaceType> makVrf::DtVrfStateViewCollectionManager::lookupAndCastObjectData

(

const std::string &

name

)

[inline]

Returns:

A DtObjectDataInterface subclass for a particular object in the system.

Parameters:

name	The entity or object name (same as Marking Text). This templated method also dynamic-casts the result to the specified DtObjectDataInterface subclass specified.

template<typename T_ObjectDataInterfaceType >

DtBoost::shared_ptr<T_ObjectDataInterfaceType> makVrf::DtVrfStateViewCollectionManager::lookupAndCastSpotReportData

(

const std::string &

name

)

[inline]

Returns:

A DtObjectDataInterface subclass for the spot report data on a particular object in the system.

Parameters:

name	The entity or object name (same as Marking Text). This templated method also dynamic-casts the result to the specified DtObjectDataInterface subclass specified.

virtual DtBoost::shared_ptr<DtObjectDataInterface> makVrf::DtVrfStateViewCollectionManager::lookupObjectData

(

makVrv::DtStateView< makVrv::DtSimState > *

stateView

)

[virtual]

Returns:

A DtObjectDataInterface subclass for a particular object in the system.

Parameters:

stateView

The DtStateView class representing the object.

makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* makVrf::DtVrfStateViewCollectionManager::findStateView

(

const std::string &

markingText

)

Returns state view given the marking text. If does not exist, then, will return NULL.

makVrv::DtStateView<DtSpotReportState>* makVrf::DtVrfStateViewCollectionManager::findSpotReportStateView

(

const std::string &

markingText

)

Returns spot report state view given the marking text. If does not exist, then, will return NULL.

makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* makVrf::DtVrfStateViewCollectionManager::findStateView

(

const makVrv::DtUniqueID &

id

)

[inline]

Finds a state view given the objects element id.

If you have a scene id, call simIdFromDisplayId to return the element id from a scene id

makVrv::DtStateView<DtSpotReportState>* makVrf::DtVrfStateViewCollectionManager::findSpotReportStateView

(

const makVrv::DtUniqueID &

id

)

[inline]

Finds a spot report state view given the objects element id.

If you have a scene id, call simIdFromDisplayId to return the element id from a scene id

DtVrfSimulatedEntityStateViewCollection* makVrf::DtVrfStateViewCollectionManager::simulatedEntityStateViewCollection

(

)

[inline]

Return collections that represent what types of state views are contained

DtVrlinkSimulatedBaseStateViewCollection* makVrf::DtVrfStateViewCollectionManager::simulatedBaseStateViewCollection

(

)

[inline]

Return collections that represent what types of state views are contained

DtVrfObjectDataStateViewCollection* makVrf::DtVrfStateViewCollectionManager::objectDataStateViewCollection

(

)

[inline]

Return collections that represent what types of state views are contained

DtEnvironmentStateViewCollection* makVrf::DtVrfStateViewCollectionManager::environmentStateViewCollection

(

)

[inline]

Return collections that represent what types of state views are contained

DtExtendedStateDataViewCollection* makVrf::DtVrfStateViewCollectionManager::extendedStateDataViewCollection

(

)

[inline]

Return collections that represent what types of state views are contained

DtIffStateDataViewCollection* makVrf::DtVrfStateViewCollectionManager::iffStateDataViewCollection

(

)

[inline]

Return collections that represent what types of state views are contained

DtSpotReportStateViewCollection* makVrf::DtVrfStateViewCollectionManager::spotReportStateViewCollection

(

)

[inline]

Return collections that represent what types of state views are contained

DtAggregateStateViewCollection* makVrf::DtVrfStateViewCollectionManager::aggregateStateViewCollection

(

)

[inline]

Return collections that represent what types of state views are contained

makVrv::DtUniqueID makVrf::DtVrfStateViewCollectionManager::parentId

(

const makVrv::DtUniqueID &

)

const

If this item has a parent (for example, a vertex) return that, else return the passed in id.

makVrv::DtUniqueID makVrf::DtVrfStateViewCollectionManager::displayIdFromSimId	(	const makVrv::DtUniqueID &	id,
		int	modelSet = -1
	)		const

makVrv::DtElementData::SceneObjectIdList makVrf::DtVrfStateViewCollectionManager::displayIdsFromSimId	(	const makVrv::DtUniqueID &	id,
		int	modelSet = -1
	)		const

makVrv::DtUniqueID makVrf::DtVrfStateViewCollectionManager::simIdFromDisplayId

(

const makVrv::DtUniqueID &

id

)

const

Returns the name of the object given the specified id.

virtual std::string makVrf::DtVrfStateViewCollectionManager::entityName

(

const makVrv::DtUniqueID

simId

)

const [virtual]

Returns an entity name based on the simulation id.

virtual std::string makVrf::DtVrfStateViewCollectionManager::overlayName

(

const makVrv::DtUniqueID

simId

)

const [virtual]

Returns the name of the overlay this item is on (if it is). Pass in element id.

virtual makVrv::DtElementEntry::ElementType makVrf::DtVrfStateViewCollectionManager::elementType

(

const makVrv::DtElementID &

)

const [virtual]

Returns the type of the element.

virtual makVrv::DtSimEntryUpdater::UpdateRate makVrf::DtVrfStateViewCollectionManager::updateRateFor

(

const makVrv::DtBaseStateView *

state

)

const [virtual]

Returns the minimum update rate for the given state view.

virtual makVrv::DtSimEntryUpdater::UpdateRate makVrf::DtVrfStateViewCollectionManager::minimumRate

(

const UpdateRates &

)

const [virtual]

virtual makVrv::DtSimEntryUpdater::UpdateRate makVrf::DtVrfStateViewCollectionManager::maximumRate

(

const UpdateRates &

)

const [virtual]

virtual void makVrf::DtVrfStateViewCollectionManager::setUpdateRate	(	makVrv::DtSimEntry *	,
		makVrv::DtSimEntryUpdater::UpdateRate	,
		makVrv::DtBaseStateView *	state
	)		[virtual]

Keeps track of update rates made for a state view.

If the update rate set is NoUpdates, removes the minimum rate, else, will add the requested rate to the list and set the new rate to the maximum rate

---

Member Data Documentation

DtVrfSimulatedEntityStateViewCollection* makVrf::DtVrfStateViewCollectionManager::mySimulatedEntityStateView [protected]

DtVrlinkSimulatedBaseStateViewCollection* makVrf::DtVrfStateViewCollectionManager::mySimulatedBaseStateViewCollection [protected]

DtVrfObjectDataStateViewCollection* makVrf::DtVrfStateViewCollectionManager::myObjectDataStateViewCollection [protected]

DtEnvironmentStateViewCollection* makVrf::DtVrfStateViewCollectionManager::myEnvironmentStateViewCollection [protected]

DtSpotReportStateViewCollection* makVrf::DtVrfStateViewCollectionManager::mySpotReportStateViewCollection [protected]

DtAggregateStateViewCollection* makVrf::DtVrfStateViewCollectionManager::myAggregateStateViewCollection [protected]

DtExtendedStateDataViewCollection* makVrf::DtVrfStateViewCollectionManager::myExtendedStateDataViewCollection [protected]

DtIffStateDataViewCollection* makVrf::DtVrfStateViewCollectionManager::myIffStateDataViewCollection [protected]

makVrv::DtDe& makVrf::DtVrfStateViewCollectionManager::myDe [protected]

UpdateRateMap makVrf::DtVrfStateViewCollectionManager::myUpdateRateMap [protected]

---

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

• include/vrfGuiCore/DtVrfStateViewCollectionManager.h