The DtEntityDataInterface 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.

Related Examples

Inheritance diagram for makVrf::DtEntityDataInterface:

[legend]

Public Member Functions
	DtEntityDataInterface (makVrv::DtDe &)

virtual	~DtEntityDataInterface ()

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

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

virtual DtVector	location (Representation rep=Local) const

virtual std::string	label () const

virtual DtTaitBryan	orientation (Representation rep=Local) const

virtual DtVector	velocity (Representation rep=Local) const

virtual DtVector	acceleration (Representation rep=Local) const

virtual double	heading () const

virtual makVrv::DtElementID	embarkedOn () const

virtual std::vector < makVrv::DtElementID >	objectsEmbarked () const

virtual makVrv::DtElementID	superior () const

makVrv::DtStateView < makVrv::DtVrlinkSimulatedEntityState > *	entityStateView () const

makVrv::DtStateView < DtIffStateData > *	iffStateDataView () const

makVrv::DtStateView < DtPropulsionNoiseStateData > *	propulsionNoiseStateDataView () const

makVrv::DtStateView < DtVrlinkEmitterSystems > *	emitterSystemStateView () const

makVrv::DtStateView < DtVrlinkActiveSonars > *	activeSonarStateView () const

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

DtVrfDataInterraceResourceRequestor &	resourceRequestor ()

virtual void	requestResources ()

virtual std::string	name () const

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

virtual std::map< int, DtString >	extendedLabels () const

virtual std::string	activity () const

virtual DtEntityType	entityType () const

virtual std::string	entityId () const

virtual std::string	globalId () const

virtual bool	isCurrentlyTasked () const

virtual bool	isExecutingPlan () const

virtual bool	hasPlan () const

const DtVrfDataInterraceResourceRequestor::ResourceMap &	resources () const

const DtUUID &	uuid () const

Public Member Functions inherited from makVrf::DtObjectDataInterface
	DtObjectDataInterface (makVrv::DtDe &)

virtual	~DtObjectDataInterface ()

makVrv::DtElementID	elementID () const

virtual makVrv::DtSimEntryUpdater::UpdateRate	setUpdateRate (makVrv::DtSimEntryUpdater::UpdateRate)

makVrv::DtSimEntryUpdater::UpdateRate	updateRate () const

virtual void	forceUpdate ()

virtual bool	isValid () const

virtual bool	hasBeenRemoved () const

virtual bool	isVisible () const

virtual void	setVisible (bool)

virtual bool	isSelected () const

virtual void	removeFromSelection ()

virtual void	addToSelection (bool replace=false)

Protected Member Functions
virtual void	slot_simObjectEntryAboutToBeRemoved (makVrv::DtSimObjectEntry &)

virtual void	slot_onIffStateViewAdded (const DtIffStateDataView &view)

virtual void	slot_onIffStateViewAboutToBeRemoved (const DtIffStateDataView &view)

Protected Member Functions inherited from makVrf::DtVrfVrlinkDataInterface
virtual void	slot_onResourcesChanged ()

virtual void	slot_onStateViewUpdated ()

Protected Member Functions inherited from makVrf::DtObjectDataInterface
virtual DtVector	geocentricVectorToLocalVector (const DtVector &localLocation, const DtVector &geocVector) const

Protected Attributes
makVrv::DtStateView < makVrv::DtVrlinkSimulatedEntityState > *	myEntityStateView

makVrv::DtStateView < DtIffStateData > *	myIffStateDataView

makVrv::DtStateView < DtPropulsionNoiseStateData > *	myPropulsionNoiseStateDataView

makVrv::DtStateView < DtVrlinkEmitterSystems > *	myEmitterSystemStateView

makVrv::DtStateView < DtVrlinkActiveSonars > *	myActiveSonarStateView

makVrv::DtSignalConnectionManager	myConnections

Protected Attributes inherited from makVrf::DtVrfVrlinkDataInterface
makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	myVrlinkStateView

makVrv::DtStateView < DtVrfObjectDataState > *	myObjectDataState

makVrv::DtStateView < DtExtendedStateData > *	myExtendedStateData

DtVrfDataInterraceResourceRequestor	myResources

DtUUID	myUUID

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 }

Static Public Member Functions inherited from makVrf::DtObjectDataInterface
template<typename T_ObjectDataInterfaceType >
static DtBoost::shared_ptr < T_ObjectDataInterfaceType >	cast (DtBoost::shared_ptr< DtObjectDataInterface > dataInterface)

Public Attributes inherited from makVrf::DtVrfVrlinkDataInterface
boost::signals2::signal< void()>	signal_resourcesChanged

Public Attributes inherited from makVrf::DtObjectDataInterface
boost::signals2::signal< void()>	signal_dataUpdated

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

Constructor & Destructor Documentation

makVrf::DtEntityDataInterface::DtEntityDataInterface ( makVrv::DtDe & )

virtual makVrf::DtEntityDataInterface::~DtEntityDataInterface ( )

virtual

Member Function Documentation

virtual void makVrf::DtEntityDataInterface::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::DtVrfVrlinkDataInterface.

Reimplemented in makVrf::DtAggregateDataInterface.

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

virtual

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

Reimplemented from makVrf::DtObjectDataInterface.

Reimplemented in makVrf::DtAggregateDataInterface.

virtual DtVector makVrf::DtEntityDataInterface::location ( Representation rep = Local ) const

virtual

Returns the location of the entity.

Reimplemented from makVrf::DtVrfVrlinkDataInterface.

virtual std::string makVrf::DtEntityDataInterface::label ( ) const

virtual

Returns the label of the object.

Reimplemented from makVrf::DtVrfVrlinkDataInterface.

virtual DtTaitBryan makVrf::DtEntityDataInterface::orientation ( Representation rep = Local ) const

virtual

Returns the orientation of the object.

virtual DtVector makVrf::DtEntityDataInterface::velocity ( Representation rep = Local ) const

virtual

Returns the objects velocity.

virtual DtVector makVrf::DtEntityDataInterface::acceleration ( Representation rep = Local ) const

virtual

Returns the objects acceleration.

virtual double makVrf::DtEntityDataInterface::heading ( ) const

virtual

Returns the objects topographic heading (in degrees)

virtual makVrv::DtElementID makVrf::DtEntityDataInterface::embarkedOn ( ) const

virtual

Returns the element this object is embarked on. An element ID of 0 means the item is not embarked.

virtual std::vector<makVrv::DtElementID> makVrf::DtEntityDataInterface::objectsEmbarked ( ) const

virtual

Returns a list of all elements that are embarked on this object.

virtual makVrv::DtElementID makVrf::DtEntityDataInterface::superior ( ) const

virtual

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>* makVrf::DtEntityDataInterface::entityStateView ( ) const

inline

Returns the state view of this class.

makVrv::DtStateView<DtIffStateData>* makVrf::DtEntityDataInterface::iffStateDataView ( ) const

inline

Returns the state view for any iff data that might be associated with this class. A NULL return means this entity does not have IFF data.

makVrv::DtStateView<DtPropulsionNoiseStateData>* makVrf::DtEntityDataInterface::propulsionNoiseStateDataView ( ) const

inline

Returns the state view for any propulsionnoise data that might be associated with this class. A NULL return means this entity does not have propulsion noise data.

makVrv::DtStateView<DtVrlinkEmitterSystems>* makVrf::DtEntityDataInterface::emitterSystemStateView ( ) const

inline

Returns the state view for any emitters that are associated with this entity. A NULL return means this entity does not have emitter data.

makVrv::DtStateView<DtVrlinkActiveSonars>* makVrf::DtEntityDataInterface::activeSonarStateView ( ) const

inline

Returns the state view for any active sonars that are associated with this entity. A NULL return means this entity does not have emitter data.

virtual void makVrf::DtEntityDataInterface::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::DtVrfVrlinkDataInterface.

Reimplemented in makVrf::DtAggregateDataInterface.

virtual void makVrf::DtEntityDataInterface::slot_onIffStateViewAdded ( const DtIffStateDataView & view )

protectedvirtual

virtual void makVrf::DtEntityDataInterface::slot_onIffStateViewAboutToBeRemoved ( const DtIffStateDataView & view )

protectedvirtual

Member Data Documentation

makVrv::DtStateView<makVrv::DtVrlinkSimulatedEntityState>* makVrf::DtEntityDataInterface::myEntityStateView

protected

makVrv::DtStateView<DtIffStateData>* makVrf::DtEntityDataInterface::myIffStateDataView

protected

makVrv::DtStateView<DtPropulsionNoiseStateData>* makVrf::DtEntityDataInterface::myPropulsionNoiseStateDataView

protected

makVrv::DtStateView<DtVrlinkEmitterSystems>* makVrf::DtEntityDataInterface::myEmitterSystemStateView

protected

makVrv::DtStateView<DtVrlinkActiveSonars>* makVrf::DtEntityDataInterface::myActiveSonarStateView

protected

makVrv::DtSignalConnectionManager makVrf::DtEntityDataInterface::myConnections

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation