VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
makVrf::DtVrfVrlinkDataInterface Class Reference

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

Inheritance diagram for makVrf::DtVrfVrlinkDataInterface:
Inheritance graph
[legend]

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. More...
 
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. More...
 
DtVrfDataInterraceResourceRequestorresourceRequestor ()
 Use this class to control the update rate of resources. More...
 
virtual void requestResources ()
 Requests resources for this item. More...
 
virtual std::string name () const
 Returns the name (marking text) of the object. More...
 
virtual std::string label () const
 Returns the label of the object. More...
 
virtual const std::map
< std::string, std::string > & 
extendedObjectData () const
 Returns extended data as supplied on the network. More...
 
virtual std::map< int, DtStringextendedLabels () const
 Returns extended labels. More...
 
virtual std::string activity () const
 
virtual DtEntityType entityType () const
 Returns the type of the object. More...
 
virtual std::string entityId () const
 Returns the objects entity id. More...
 
virtual std::string globalId () const
 Returns the objects global id. More...
 
virtual bool isCurrentlyTasked () const
 Returns if object is currently tasked. More...
 
virtual bool isExecutingPlan () const
 Returns if executing a plan. More...
 
virtual DtVector location (Representation rep=Local) const
 If avaiable returns the location of the object. More...
 
const
DtVrfDataInterraceResourceRequestor::ResourceMap
resources () const
 
const DtUUIDuuid () const
 
- Public Member Functions inherited from makVrf::DtObjectDataInterface
 DtObjectDataInterface (makVrv::DtDe &)
 
virtual ~DtObjectDataInterface ()
 
makVrv::DtElementID elementID () const
 Returns the element id of this object. More...
 
virtual
makVrv::DtElementEntry::ElementType 
type () const
 Returns the type of this object. More...
 
virtual
makVrv::DtSimEntryUpdater::UpdateRate 
setUpdateRate (makVrv::DtSimEntryUpdater::UpdateRate)
 Sets the update rate for the data contained in this data interface. More...
 
makVrv::DtSimEntryUpdater::UpdateRate updateRate () const
 Returns the current update rate. More...
 
virtual void forceUpdate ()
 Forces an update of the data so on the next tick the network thread will update data in the gui thread. More...
 
virtual bool isValid () const
 Returns true if this is a valid data interface. More...
 
virtual bool hasBeenRemoved () const
 Returns true if this item has been removed from the simulation. More...
 
virtual bool isVisible () const
 Returns true if the item is visible. More...
 
virtual void setVisible (bool)
 Sets the item to visible or invisible. More...
 
virtual bool isSelected () const
 Returns true if the item is selected. More...
 
virtual void removeFromSelection ()
 Removes the item from the current selection. More...
 
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. More...
 

Public Attributes

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

Protected Member Functions

virtual void slot_onResourcesChanged ()
 Slot called when resources have changed. Will send out resourcesChanged signal. More...
 
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. More...
 
virtual void slot_onStateViewUpdated ()
 Update UUID if not set. More...
 
- 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. More...
 

Protected Attributes

makVrv::DtStateView
< makVrv::DtVrlinkSimulatedBaseState > * 
myVrlinkStateView
 
makVrv::DtStateView
< DtVrfObjectDataState > * 
myObjectDataState
 
makVrv::DtStateView
< DtExtendedStateData > * 
myExtendedStateData
 
DtVrfDataInterraceResourceRequestor myResources
 
DtUUID myUUID
 
- Protected Attributes inherited from makVrf::DtObjectDataInterface
makVrv::DtDemyDe
 
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. More...
 

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::extendedStateData ( ) const
virtual

Extended state data, if exists.

This is data that is added that is not necessarily sent over the network and is not part of the extendedData member of state repositories

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::label ( ) const
virtual

Returns the label of the object.

Reimplemented in makVrf::DtEntityDataInterface.

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

Returns extended data as supplied on the network.

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

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

Returns extended labels.

virtual std::string makVrf::DtVrfVrlinkDataInterface::activity ( ) const
virtual
virtual DtEntityType 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
const DtUUID& makVrf::DtVrfVrlinkDataInterface::uuid ( ) 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.

virtual void makVrf::DtVrfVrlinkDataInterface::slot_onStateViewUpdated ( )
protectedvirtual

Update UUID if not set.

Reimplemented from makVrf::DtObjectDataInterface.

Member Data Documentation

boost::signals2::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
DtUUID makVrf::DtVrfVrlinkDataInterface::myUUID
protected

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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)