The DtAggregateDataInterface class is a wrapper around state views to give access to convenience methods which will allow developers to more easily access data about those objects. More...

Inheritance diagram for makVrf::DtAggregateDataInterface:

[legend]

Public Member Functions
	DtAggregateDataInterface (makVrv::DtDe &)
virtual	~DtAggregateDataInterface ()
virtual void	setStateView (const makVrv::DtStateView< makVrv::DtSimState > *)
	Called to set the state view this data will wrap.
virtual makVrv::DtElementEntry::ElementType	type () const
	Returns the type of this object. Used for dynamic casting to proper sub-class.
virtual const std::map < std::string, std::string > &	extendedObjectData () const
	Returns extended data as supplied on the network.
virtual std::vector < makVrv::DtElementID >	subordinates () const
	Returns a list of all subordinates this object.
virtual std::string	formation () const
	Returns the current formation of this object.
virtual DtVector	dimensions () const
	Returns the aggregate dimensions.
makVrv::DtStateView < DtVrlinkSimulatedAggregateState > *	aggregateStateView () const
	Returns the state view of this class.
Public Member Functions inherited from makVrf::DtEntityDataInterface
	DtEntityDataInterface (makVrv::DtDe &)
virtual	~DtEntityDataInterface ()
virtual DtVector	location (Representation rep=Local) const
	Returns the location of the entity.
virtual std::string	label () const
	Returns the label of the object.
virtual DtTaitBryan	orientation (Representation rep=Local) const
	Returns the orientation of the object.
virtual DtVector	velocity (Representation rep=Local) const
	Returns the objects velocity.
virtual DtVector	acceleration (Representation rep=Local) const
	Returns the objects acceleration.
virtual double	heading () const
	Returns the objects topographic heading (in degrees)
virtual makVrv::DtElementID	embarkedOn () const
	Returns the element this object is embarked on. An element ID of 0 means the item is not embarked.
virtual std::vector < makVrv::DtElementID >	objectsEmbarked () const
	Returns a list of all elements that are embarked on this object.
virtual makVrv::DtElementID	superior () const
	Returns the ID of the superior of this object. If the ID is 0 the object superior is the force level object.
makVrv::DtStateView < makVrv::DtVrlinkSimulatedEntityState > *	entityStateView () const
	Returns the state view of this class.
makVrv::DtStateView < DtIffStateData > *	iffStateDataView () const
	Returns the state view for any iff data that might be associated with this class.
makVrv::DtStateView < DtPropulsionNoiseStateData > *	propulsionNoiseStateDataView () const
	Returns the state view for any propulsionnoise data that might be associated with this class.
makVrv::DtStateView < DtVrlinkEmitterSystems > *	emitterSystemStateView () const
	Returns the state view for any emitters that are associated with this entity.
makVrv::DtStateView < DtVrlinkActiveSonars > *	activeSonarStateView () const
	Returns the state view for any active sonars that are associated with this entity.
Public Member Functions inherited from makVrf::DtVrfVrlinkDataInterface
	DtVrfVrlinkDataInterface (makVrv::DtDe &)
virtual	~DtVrfVrlinkDataInterface ()
makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	vrlinkStateView () const
makVrv::DtStateView < DtVrfObjectDataState > *	objectDataState () const
const makVrv::DtStateView < DtExtendedStateData > *	extendedDataState () const
virtual const DtSimpleTypedDictionary &	extendedStateData () const
	Extended state data, if exists.
DtVrfDataInterraceResourceRequestor &	resourceRequestor ()
	Use this class to control the update rate of resources.
virtual void	requestResources ()
	Requests resources for this item.
virtual std::string	name () const
	Returns the name (marking text) of the object.
virtual std::map< int, DtString >	extendedLabels () const
	Returns extended labels.
virtual std::string	activity () const
virtual std::string	entityType () const
	Returns the type of the object.
virtual std::string	entityId () const
	Returns the objects entity id.
virtual std::string	globalId () const
	Returns the objects global id.
virtual bool	isCurrentlyTasked () const
	Returns if object is currently tasked.
virtual bool	isExecutingPlan () const
	Returns if executing a plan.
const DtVrfDataInterraceResourceRequestor::ResourceMap &	resources () const
Public Member Functions inherited from makVrf::DtObjectDataInterface
	DtObjectDataInterface (makVrv::DtDe &)
virtual	~DtObjectDataInterface ()
makVrv::DtElementID	elementID () const
	Returns the element id of this object.
virtual makVrv::DtSimEntryUpdater::UpdateRate	setUpdateRate (makVrv::DtSimEntryUpdater::UpdateRate)
	Sets the update rate for the data contained in this data interface.
makVrv::DtSimEntryUpdater::UpdateRate	updateRate () const
	Returns the current update rate.
virtual void	forceUpdate ()
	Forces an update of the data so on the next tick the network thread will update data in the gui thread.
virtual bool	isValid () const
	Returns true if this is a valid data interface.
virtual bool	hasBeenRemoved () const
	Returns true if this item has been removed from the simulation.
virtual bool	isVisible () const
	Returns true if the item is visible.
virtual void	setVisible (bool)
	Sets the item to visible or invisible.
virtual bool	isSelected () const
	Returns true if the item is selected.
virtual void	removeFromSelection ()
	Removes the item from the current selection.
virtual void	addToSelection (bool replace=false)
	Adds the item to the current selection. If replace is true will replace the current selection and leave only the item.

Protected Member Functions
virtual void	slot_simObjectEntryAboutToBeRemoved (makVrv::DtSimObjectEntry &)
	Slot that is called when the state view is destroyed. Will mark this item as removed by clearing out internal pointers.

Protected Attributes
makVrv::DtStateView < DtVrlinkSimulatedAggregateState > *	myAggregateStateView
Protected Attributes inherited from makVrf::DtEntityDataInterface
makVrv::DtStateView < makVrv::DtVrlinkSimulatedEntityState > *	myEntityStateView
makVrv::DtStateView < DtIffStateData > *	myIffStateDataView
makVrv::DtStateView < DtPropulsionNoiseStateData > *	myPropulsionNoiseStateDataView
makVrv::DtStateView < DtVrlinkEmitterSystems > *	myEmitterSystemStateView
makVrv::DtStateView < DtVrlinkActiveSonars > *	myActiveSonarStateView
Protected Attributes inherited from makVrf::DtVrfVrlinkDataInterface
makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	myVrlinkStateView
makVrv::DtStateView < DtVrfObjectDataState > *	myObjectDataState
makVrv::DtStateView < DtExtendedStateData > *	myExtendedStateData
DtVrfDataInterraceResourceRequestor	myResources
Protected Attributes inherited from makVrf::DtObjectDataInterface
makVrv::DtDe &	myDe
makVrv::DtStateView < makVrv::DtSimState > *	myStateView

Additional Inherited Members
Public Types inherited from makVrf::DtObjectDataInterface
enum	Representation { Local = 0, World = 1 }
	Use these enums in various information methods to return data in local or world coordinates. More...
Static Public Member Functions inherited from makVrf::DtObjectDataInterface
template<typename T_ObjectDataInterfaceType >
static DtBoost::shared_ptr < T_ObjectDataInterfaceType >	cast (DtBoost::shared_ptr< DtObjectDataInterface > dataInterface)
	This is a convenience method for casting a DtBoost::shared_ptr to a DtObjectDataInterface to a derived class.
Public Attributes inherited from makVrf::DtVrfVrlinkDataInterface
boost::signal< void()>	signal_resourcesChanged
	Signal sent when resources have changed.

Detailed Description

The DtAggregateDataInterface class is a wrapper around state views to give access to convenience methods which will allow developers to more easily access data about those objects.

It will also provide some basic manipulation for that object

Constructor & Destructor Documentation

makVrf::DtAggregateDataInterface::DtAggregateDataInterface ( makVrv::DtDe & )

virtual makVrf::DtAggregateDataInterface::~DtAggregateDataInterface ( )

virtual

Member Function Documentation

virtual void makVrf::DtAggregateDataInterface::setStateView ( const makVrv::DtStateView< makVrv::DtSimState > * )

virtual

Called to set the state view this data will wrap.

Subclasses are responsible for providing interface to access the specific data, however, you can access the data through the state() members of the contained state views. Overridden to cast to appropriate type

Reimplemented from makVrf::DtEntityDataInterface.

virtual makVrv::DtElementEntry::ElementType makVrf::DtAggregateDataInterface::type ( ) const

virtual

Returns the type of this object. Used for dynamic casting to proper sub-class.

Reimplemented from makVrf::DtEntityDataInterface.

virtual const std::map<std::string, std::string>& makVrf::DtAggregateDataInterface::extendedObjectData ( ) const

virtual

Returns extended data as supplied on the network.

Reimplemented from makVrf::DtVrfVrlinkDataInterface.

virtual std::vector<makVrv::DtElementID> makVrf::DtAggregateDataInterface::subordinates ( ) const

virtual

Returns a list of all subordinates this object.

virtual std::string makVrf::DtAggregateDataInterface::formation ( ) const

virtual

Returns the current formation of this object.

virtual DtVector makVrf::DtAggregateDataInterface::dimensions ( ) const

virtual

Returns the aggregate dimensions.

makVrv::DtStateView<DtVrlinkSimulatedAggregateState>* makVrf::DtAggregateDataInterface::aggregateStateView ( ) const

inline

Returns the state view of this class.

virtual void makVrf::DtAggregateDataInterface::slot_simObjectEntryAboutToBeRemoved ( makVrv::DtSimObjectEntry & )

protectedvirtual

Slot that is called when the state view is destroyed. Will mark this item as removed by clearing out internal pointers.

Reimplemented from makVrf::DtEntityDataInterface.

Member Data Documentation

makVrv::DtStateView<DtVrlinkSimulatedAggregateState>* makVrf::DtAggregateDataInterface::myAggregateStateView

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfGuiCore/aggregateDataInterface.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation