makVrf::DtVrfVrlinkDataInterface Class Reference

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

Inheritance diagram for makVrf::DtVrfVrlinkDataInterface:

List of all members.

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.
const DtVrfDataInterraceResourceRequestor::ResourceMap &	resources () const
Public Attributes
boost::signal< void()>	signal_resourcesChanged
	Signal sent when resources have changed.
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 Attributes
makVrv::DtStateView < makVrv::DtVrlinkSimulatedBaseState > *	myVrlinkStateView
makVrv::DtStateView < DtVrfObjectDataState > *	myObjectDataState
makVrv::DtStateView < DtExtendedStateData > *	myExtendedStateData
DtVrfDataInterraceResourceRequestor	myResources

---

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.

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

(

)

const

virtual void makVrf::DtVrfVrlinkDataInterface::slot_onResourcesChanged

(

)

[protected, virtual]

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

virtual void makVrf::DtVrfVrlinkDataInterface::slot_simObjectEntryAboutToBeRemoved

(

makVrv::DtSimObjectEntry &

)

[protected, virtual]

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:

• include/vrfGuiCore/DtVrfVrlinkDataInterface.h