makVrf::DtVrfVrlinkDataInterface Class Reference

This subclass of DtObjectDataInterface accesses data from a VR-Forces object from the network. More...

Inheritance diagram for makVrf::DtVrfVrlinkDataInterface:

Public Member Functions
	DtVrfVrlinkDataInterface (makVrv::DtDe &)
virtual	~DtVrfVrlinkDataInterface ()
virtual void	setStateView (const makVrv::DtStateView< makVrv::DtSimState > *)
	Called to set the state view this data will wrap.
makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	vrlinkStateView () const
makVrv::DtStateView < DtVrfObjectDataState > *	objectDataState () const
const makVrv::DtStateView < DtExtendedStateData > *	extendedDataState () const
virtual const DtSimpleTypedDictionary &	extendedData () const
	Extended state data, if exists. Default if not.
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::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.
virtual DtVector	location (Representation rep=Local) const
	If avaiable returns the location of the object.
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::DtElementEntry::ElementType	type () const
	Returns the type 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.

Public Attributes
boost::signal< void()>	signal_resourcesChanged
	Signal sent when resources have changed.
Public Attributes inherited from makVrf::DtObjectDataInterface
boost::signal< void()>	signal_dataUpdated
	Signal sent when any of this items data has been updated.
boost::signal< void()>	signal_dataRemoved
	Signal send when this items data has been removed.

Protected Member Functions
virtual void	slot_onResourcesChanged ()
	Slot called when resources have changed. Will send out resourcesChanged signal.
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 Member Functions inherited from makVrf::DtObjectDataInterface
virtual DtVector	geocentricVectorToLocalVector (const DtVector &localLocation, const DtVector &geocVector) const
	Converts a geocentric vector to a local vector, given the local location.
virtual void	slot_onStateViewUpdated ()
	Called when any of the state views data has been updated. Sends out signal_dataUpdated.

Protected Attributes
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.

Detailed Description

This subclass of DtObjectDataInterface accesses data from a VR-Forces object from the network.

The basic level of data from DIS or RPR FOM is available, as well as the DtExtendedStateData dictionary.

Classes derived from this class provide access to more type-specific data.

Resources will be requested when the sim state view is set. A signal will be sent when the resources are received or changed

Constructor & Destructor Documentation

makVrf::DtVrfVrlinkDataInterface::DtVrfVrlinkDataInterface

(

makVrv::DtDe &

)

virtual makVrf::DtVrfVrlinkDataInterface::~DtVrfVrlinkDataInterface ( )

virtual

Member Function Documentation

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

Reimplemented from makVrf::DtObjectDataInterface.

Reimplemented in makVrf::DtEntityDataInterface, makVrf::DtAggregateDataInterface, and makVrf::DtTacticalGraphicDataInterface.

makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* makVrf::DtVrfVrlinkDataInterface::vrlinkStateView ( ) const

inline

makVrv::DtStateView<DtVrfObjectDataState>* makVrf::DtVrfVrlinkDataInterface::objectDataState ( ) const

inline

const makVrv::DtStateView<DtExtendedStateData>* makVrf::DtVrfVrlinkDataInterface::extendedDataState ( ) const

inline

virtual const DtSimpleTypedDictionary& makVrf::DtVrfVrlinkDataInterface::extendedData ( ) const

virtual

Extended state data, if exists. Default if not.

DtVrfDataInterraceResourceRequestor& makVrf::DtVrfVrlinkDataInterface::resourceRequestor

(

)

Use this class to control the update rate of resources.

virtual void makVrf::DtVrfVrlinkDataInterface::requestResources ( )

virtual

Requests resources for this item.

Connect to signal to be notified when resources are available

virtual std::string makVrf::DtVrfVrlinkDataInterface::name ( ) const

virtual

Returns the name (marking text) of the object.

virtual std::string makVrf::DtVrfVrlinkDataInterface::entityType ( ) const

virtual

Returns the type of the object.

virtual std::string makVrf::DtVrfVrlinkDataInterface::entityId ( ) const

virtual

Returns the objects entity id.

virtual std::string makVrf::DtVrfVrlinkDataInterface::globalId ( ) const

virtual

Returns the objects global id.

virtual bool makVrf::DtVrfVrlinkDataInterface::isCurrentlyTasked ( ) const

virtual

Returns if object is currently tasked.

virtual bool makVrf::DtVrfVrlinkDataInterface::isExecutingPlan ( ) const

virtual

Returns if executing a plan.

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

virtual

If avaiable returns the location of the object.

For multi-point objects will return the geometric center of the object

Reimplemented in makVrf::DtEntityDataInterface, and makVrf::DtTacticalGraphicDataInterface.

const DtVrfDataInterraceResourceRequestor::ResourceMap& makVrf::DtVrfVrlinkDataInterface::resources

(

)

const

virtual void makVrf::DtVrfVrlinkDataInterface::slot_onResourcesChanged ( )

protectedvirtual

Slot called when resources have changed. Will send out resourcesChanged signal.

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

Reimplemented in makVrf::DtEntityDataInterface, makVrf::DtTacticalGraphicDataInterface, and makVrf::DtAggregateDataInterface.

Member Data Documentation

boost::signal<void ()> makVrf::DtVrfVrlinkDataInterface::signal_resourcesChanged

Signal sent when resources have changed.

makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* makVrf::DtVrfVrlinkDataInterface::myVrlinkStateView

protected

makVrv::DtStateView<DtVrfObjectDataState>* makVrf::DtVrfVrlinkDataInterface::myObjectDataState

protected

makVrv::DtStateView<DtExtendedStateData>* makVrf::DtVrfVrlinkDataInterface::myExtendedStateData

protected

DtVrfDataInterraceResourceRequestor makVrf::DtVrfVrlinkDataInterface::myResources

protected

---

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

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