makVrf::DtSimObjectNetInterface Class Reference

Class Description: DtSimObjectNetInterface.

DtSimObjectNetInterface is an abstract base class that represents the interface between a simulation object's local representation in VR-Forces and its network (VR-Link) representation

Inheritance diagram for makVrf::DtSimObjectNetInterface:

Classes
class	ParallelContainer

Public Member Functions
DtVrfCallbackQueue::CallbackInterface::Ptr	parallelContainer ()
	DtSimObjectNetInterface (DtStateData *simObject, DtVrlinkNetworkInterface *, bool publishObject=true)
virtual	~DtSimObjectNetInterface ()
virtual bool	init (const DtEntityIdentifier &id=DtEntityIdentifier())
virtual void	tick ()
virtual void	onTick ()=0
virtual bool	isUnit () const =0
virtual bool	isEntity () const =0
virtual bool	isEnvironmental () const =0
virtual bool	wantsToCreatePublisher () const =0
virtual bool	isLocal () const =0
virtual DtString	type () const =0
virtual int	maxNameLength () const
virtual void	toBeRemoved ()
virtual bool	publishObject () const
virtual RTI::ObjectClassHandle	objectClassHandle () const =0
virtual void	sendFinalPduOnDestruction (bool)
bool	isValid () const
virtual void	parallelTick ()
virtual void	forceUpdate ()

Static Public Member Functions
static void	setNonVrfUUIDResolver (DtNonVrfUUIDResolver *)
static DtNonVrfUUIDResolver *	nonVrfUUIDResolver ()
static void	addSimObjectNetInterfaceCreatorFcn (const DtString &type, DtSimObjectNetIfaceCreatorFcn fcn)
static void	setFactory (DtSimObjectNetInterfaceFactory *factory)
static DtSimObjectNetInterfaceFactory *	factory ()
static DtSimObjectNetInterface *	createNetInterface (const DtString &type, DtStateData *simObject, DtVrlinkNetworkInterface *, bool publishObject=true)
static int	maxNameLengthForInterfaceType (const DtString &interfaceTypeString)
static void	setNonVrfObjectsUUIDScheme (const DtString &)
static DtString	nonVrfObjectsUUIDScheme ()

Public Attributes
boost::signals2::signal< void()>	signal_networkInterfaceDeleted

Static Public Attributes
static tbb::spin_rw_mutex	thePublisherCreationMutex
static tbb::spin_rw_mutex	thePublisherTickMutex

Protected Member Functions
virtual void	stateDataDestroyed ()
bool	runFullyThreaded () const
const DtStateData *	vrfObject () const
DtStateData *	nextFrameVrfObject ()
virtual const DtStateRepository *	networkState () const

Protected Attributes
DtStateData *	mySimObject
DtVrlinkNetworkInterface *	myObjectManager
DtStateRepository *	myNetworkState
bool	myNeedsNetworkSetup
DtNetInterfaceParallelLock	myLock
boost::signals2::connection	mySimObjectRemovalConnection
tbb::mutex	myDeleteGuardMutex
DtVrfCallbackQueue::CallbackInterface::Ptr	myParallelContainer

Static Protected Attributes
static DtSimObjectNetInterfaceFactory *	theFactory
static DtNonVrfUUIDResolver *	theNonVrfUUIDResolver

Private Member Functions
	DtSimObjectNetInterface ()
	DtSimObjectNetInterface (const DtSimObjectNetInterface &orig)
const DtSimObjectNetInterface &	operator= (const DtSimObjectNetInterface &orig)

Friends
class	DtVrlinkNetworkInterface
class	DtPrintObjectStatusCommand
class	DtPrintOrgViewCommand

Constructor & Destructor Documentation

makVrf::DtSimObjectNetInterface::DtSimObjectNetInterface ( )

private

default constructor

makVrf::DtSimObjectNetInterface::DtSimObjectNetInterface ( const DtSimObjectNetInterface &  orig )

private

copy constructor

makVrf::DtSimObjectNetInterface::DtSimObjectNetInterface	(	DtStateData *	simObject,
		DtVrlinkNetworkInterface *	,
		bool	publishObject = true
	)

read/writable constructor Publish object flag indicate whether or not locally simulated objects should actually publish the object on the network. If flag is false, no PDUs/RPR interactions should be sent over the network for the object.

virtual makVrf::DtSimObjectNetInterface::~DtSimObjectNetInterface ( )

virtual

destructor

Member Function Documentation

const DtSimObjectNetInterface& makVrf::DtSimObjectNetInterface::operator= ( const DtSimObjectNetInterface &  orig )

private

assignment operator

DtVrfCallbackQueue::CallbackInterface::Ptr makVrf::DtSimObjectNetInterface::parallelContainer ( )

inline

virtual bool makVrf::DtSimObjectNetInterface::init ( const DtEntityIdentifier &  id = DtEntityIdentifier() )

inlinevirtual

Derived classes that need to perform virtual construction my override this function as desired.

Reimplemented in makVrf::DtWeatherLocalNetInterface, makVrf::DtSimLocalEntityNetInterface, makVrf::DtAerodromeLocalNetInterface, and makVrf::DtSimLocalEnvironmentalNetInterface.

virtual void makVrf::DtSimObjectNetInterface::tick ( )

virtual

Clears the changed flag for the tick, then calls onTick(). Derived classes override onTick() to perform the work of updating or retrieving data in the network state repository. If overridden, make sure to call down to this base class version first, to ensure that the object changed flag is cleared before any other functions are called.

Reimplemented in makVrf::DtStateComponentNetInterface.

virtual void makVrf::DtSimObjectNetInterface::onTick ( )

pure virtual

Depending on the whether or not the entity is local or remote, this will cause the VR-Link network repository info to be copied to the local state repository or vice versa.

Implemented in makVrf::DtWeatherLocalNetInterface, makVrf::DtLocalExtendedPropertiesNetInterface< DtSimIndividualLocalEntityNetInterface, DtExtEntityStateRepository >, makVrf::DtLocalExtendedPropertiesNetInterface< DtSimPseudoAggregateLocalEntityNetInterface, DtExtAggregateStateRepository >, makVrf::DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtWeatherObjectRepository >, makVrf::DtLocalExtendedPropertiesNetInterface< DtSimAggregateLocalEntityNetInterface, DtExtAggregateStateRepository >, makVrf::DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtControlObjectRepository >, makVrf::DtMetocServiceLocalNetInterface, makVrf::DtAerodromeLocalNetInterface, makVrf::DtEnvironmentConditionRemoteNetInterface, makVrf::DtSimLocalEnvironmentalNetInterface, makVrf::DtSimLocalEntityNetInterface, makVrf::DtSimRemoteEnvironmentalNetInterface, makVrf::DtTimeAndDateRemoteNetInterface, makVrf::DtAerodromeRemoteNetInterface, makVrf::DtSimLocalControlObjectNetInterface, makVrf::DtSimRemoteEntityNetInterface, makVrf::DtRemoteStateComponentNetInterface, and makVrf::DtLocalStateComponentNetInterface.

virtual bool makVrf::DtSimObjectNetInterface::isUnit ( ) const

pure virtual

Is this network interface for a local (true) or remote (false) object? Deriving network interfaces should implement this function to return the appropriate value.

Implemented in makVrf::DtSimAggregateRemoteEntityNetInterface, makVrf::DtSimIndividualRemoteEntityNetInterface, makVrf::DtAerodromeRemoteNetInterface, makVrf::DtSimIndividualLocalEntityNetInterface, makVrf::DtSimEnvironmentalNetInterface, makVrf::DtStateComponentNetInterface, makVrf::DtAerodromeLocalNetInterface, makVrf::DtSimAggregateLocalEntityNetInterface, makVrf::DtRemoteStateComponentNetInterface, and makVrf::DtLocalStateComponentNetInterface.

virtual bool makVrf::DtSimObjectNetInterface::isEntity ( ) const

pure virtual

Implemented in makVrf::DtSimAggregateRemoteEntityNetInterface, makVrf::DtSimIndividualRemoteEntityNetInterface, makVrf::DtAerodromeRemoteNetInterface, makVrf::DtSimIndividualLocalEntityNetInterface, makVrf::DtSimEnvironmentalNetInterface, makVrf::DtStateComponentNetInterface, makVrf::DtAerodromeLocalNetInterface, makVrf::DtSimAggregateLocalEntityNetInterface, makVrf::DtRemoteStateComponentNetInterface, and makVrf::DtLocalStateComponentNetInterface.

virtual bool makVrf::DtSimObjectNetInterface::isEnvironmental ( ) const

pure virtual

Implemented in makVrf::DtAerodromeRemoteNetInterface, makVrf::DtSimIndividualLocalEntityNetInterface, makVrf::DtSimEnvironmentalNetInterface, makVrf::DtStateComponentNetInterface, makVrf::DtAerodromeLocalNetInterface, makVrf::DtSimAggregateLocalEntityNetInterface, makVrf::DtSimEntityNetInterface, makVrf::DtRemoteStateComponentNetInterface, and makVrf::DtLocalStateComponentNetInterface.

virtual bool makVrf::DtSimObjectNetInterface::wantsToCreatePublisher ( ) const

pure virtual

Returns true if this interface wants to create a publisher. This cannot be done in parallel.

Implemented in makVrf::DtSimLocalControlObjectNetInterface, makVrf::DtSimRemoteEnvironmentalNetInterface, makVrf::DtTaskVisualizationLocalNetInterface, makVrf::DtSimRemoteEntityNetInterface, makVrf::DtSimLocalEnvironmentalNetInterface, makVrf::DtAerodromeLocalNetInterface, makVrf::DtActiveSonarLocalNetInterface, makVrf::DtSimIndividualLocalEntityNetInterface, makVrf::DtIffLocalNetInterface, makVrf::DtWindCorridorLocalNetInterface, makVrf::DtEmitterSystemLocalNetInterface, makVrf::DtTimeAndDateLocalNetInterface, makVrf::DtUnderwaterAcousticsLocalNetInterface, makVrf::DtRadioTransmitterLocalNetInterface, makVrf::DtSensorFieldOfViewLocalNetInterface, makVrf::DtLaserDesignatorLocalNetInterface, makVrf::DtRemoteStateComponentNetInterface, makVrf::DtAerodromeRemoteNetInterface, makVrf::DtSimAggregateLocalEntityNetInterface, makVrf::DtDynamicTerrainLocalNetInterface, makVrf::DtRadioReceiverLocalNetInterface, and makVrf::DtNavAidRadioTransmitterLocalNetInterface.

virtual bool makVrf::DtSimObjectNetInterface::isLocal ( ) const

pure virtual

Is this network interface for a local (true) or remote (false) object? Local network interfaces should implement this function to return true. Remote network interfaces should implement this to return true.

Implemented in makVrf::DtSimLocalEnvironmentalNetInterface, makVrf::DtSimLocalEntityNetInterface, makVrf::DtTaskVisualizationLocalNetInterface, makVrf::DtSimRemoteEnvironmentalNetInterface, makVrf::DtSimRemoteEntityNetInterface, makVrf::DtAerodromeRemoteNetInterface, makVrf::DtActiveSonarLocalNetInterface, makVrf::DtAerodromeLocalNetInterface, makVrf::DtIffLocalNetInterface, makVrf::DtWindCorridorLocalNetInterface, makVrf::DtEmitterSystemLocalNetInterface, makVrf::DtTimeAndDateLocalNetInterface, makVrf::DtDynamicTerrainLocalNetInterface, makVrf::DtRadioReceiverLocalNetInterface, makVrf::DtUnderwaterAcousticsLocalNetInterface, makVrf::DtRadioTransmitterLocalNetInterface, makVrf::DtSensorFieldOfViewLocalNetInterface, makVrf::DtLaserDesignatorLocalNetInterface, makVrf::DtRemoteStateComponentNetInterface, and makVrf::DtLocalStateComponentNetInterface.

virtual DtString makVrf::DtSimObjectNetInterface::type ( ) const

pure virtual

Returns the type of net interface object. Strings are defined in netIfTypes.h.

Implemented in makVrf::DtSimAggregateLocalEntityNetInterface, makVrf::DtSimIndividualLocalEntityNetInterface, makVrf::DtSimLocalControlObjectNetInterface, makVrf::DtTaskVisualizationLocalNetInterface, makVrf::DtSimRemoteEnvironmentalNetInterface, makVrf::DtWeatherLocalNetInterface, makVrf::DtSimAggregateRemoteEntityNetInterface, makVrf::DtEnvironmentConditionRemoteNetInterface, makVrf::DtSimIndividualRemoteEntityNetInterface, makVrf::DtSimLocalEnvironmentalNetInterface, makVrf::DtRemoteTacticalSmokeNetInterface, makVrf::DtActiveSonarLocalNetInterface, makVrf::DtMetocServiceLocalNetInterface, makVrf::DtSimLocalTacticalSmokeNetInterface, makVrf::DtSimPseudoAggregateLocalEntityNetInterface, makVrf::DtIffLocalNetInterface, makVrf::DtWindCorridorLocalNetInterface, makVrf::DtEmitterSystemLocalNetInterface, makVrf::DtTimeAndDateLocalNetInterface, makVrf::DtAerodromeRemoteNetInterface, makVrf::DtTimeAndDateRemoteNetInterface, makVrf::DtUnderwaterAcousticsLocalNetInterface, makVrf::DtWindCorridorRemoteNetInterface, makVrf::DtAerodromeLocalNetInterface, makVrf::DtDynamicTerrainLocalNetInterface, makVrf::DtRadioTransmitterLocalNetInterface, makVrf::DtIffRemoteNetInterface, makVrf::DtRadioReceiverLocalNetInterface, makVrf::DtRadioReceiverRemoteNetInterface, makVrf::DtRadioTransmitterRemoteNetInterface, makVrf::DtSensorFieldOfViewLocalNetInterface, makVrf::DtActiveSonarRemoteNetInterface, makVrf::DtEmitterSystemRemoteNetInterface, makVrf::DtLaserDesignatorLocalNetInterface, makVrf::DtSimPseudoAggregateLocalEntityWithPropertiesNetInterface, makVrf::DtVrfAggregateRemoteEntityWithPropertiesNetInterface, makVrf::DtVrfIndividualRemoteEntityWithPropertiesNetInterface, makVrf::DtDynamicTerrainRemoteNetInterface, makVrf::DtLocalEngineeringObjectNetInterface, makVrf::DtSimLocalControlObjectWithPropertiesNetInterface, makVrf::DtVrfRemoteEnvironmentalWithPropertiesNetInterface, makVrf::DtLaserDesignatorRemoteNetInterface, makVrf::DtRemoteEngineeringObjectNetInterface, makVrf::DtSimAggregateLocalEntityWithPropertiesNetInterface, makVrf::DtSimIndividualLocalEntityWithPropertiesNetInterface, makVrf::DtUnderwaterAcousticsRemoteNetInterface, makVrf::DtVrfIndividualRemoteEntityNetInterface, makVrf::DtNavAidRadioTransmitterLocalNetInterface, makVrf::DtVrfRemoteEnvironmentalNetInterface, makVrf::DtNavAidRadioTransmitterRemoteNetInterface, makVrf::DtVrfAggregateRemoteEntityNetInterface, DtIndividualLocalEntityNetInterfaceWithTemperature, and DtIndividualRemoteEntityNetInterfaceWithTemperature.

virtual int makVrf::DtSimObjectNetInterface::maxNameLength ( ) const

virtual

Deprecated:

To be removed after VR-Forces version 3.11 Calls maxNameLengthForInterfaceType(type()).

virtual void makVrf::DtSimObjectNetInterface::toBeRemoved ( )

virtual

Called when this object is removed.

Reimplemented in makVrf::DtSimRemoteEnvironmentalNetInterface, makVrf::DtAerodromeRemoteNetInterface, and makVrf::DtSimRemoteEntityNetInterface.

virtual bool makVrf::DtSimObjectNetInterface::publishObject ( ) const

inlinevirtual

Reimplemented in makVrf::DtSimLocalEnvironmentalNetInterface, makVrf::DtSimLocalEntityNetInterface, makVrf::DtAerodromeLocalNetInterface, makVrf::DtStateComponentNetInterface, and makVrf::DtLocalStateComponentNetInterface.

virtual RTI::ObjectClassHandle makVrf::DtSimObjectNetInterface::objectClassHandle ( ) const

pure virtual

Returns the HLA object class handle of the published or reflected object.

Implemented in makVrf::DtSimAggregateLocalEntityNetInterface, makVrf::DtSimLocalEnvironmentalNetInterface, makVrf::DtSimRemoteEntityNetInterface, makVrf::DtSimIndividualLocalEntityNetInterface, makVrf::DtSimRemoteEnvironmentalNetInterface, makVrf::DtAerodromeRemoteNetInterface, makVrf::DtAerodromeLocalNetInterface, makVrf::DtEnvironmentConditionRemoteNetInterface, makVrf::DtStateComponentNetInterface, and makVrf::DtMetocServiceLocalNetInterface.

static void makVrf::DtSimObjectNetInterface::setNonVrfObjectsUUIDScheme ( const DtString &  )

static

Sets the UUID scheme for non vrf objects. The default is entity-identifier. Options are: entity-identifier global-identifier marking-text.

static DtString makVrf::DtSimObjectNetInterface::nonVrfObjectsUUIDScheme ( )

static

Sets the UUID scheme for non vrf objects. The default is entity-identifier. Options are: entity-identifier global-identifier marking-text.

static void makVrf::DtSimObjectNetInterface::setNonVrfUUIDResolver ( DtNonVrfUUIDResolver *  )

static

Sets the resolver that is to be used when resolving non-VR-Forces uuids. If one exists, and is owned by VRF, it will be deleted. The current scheme will not be applied to the newly set resolver.

static DtNonVrfUUIDResolver* makVrf::DtSimObjectNetInterface::nonVrfUUIDResolver ( )

static

static void makVrf::DtSimObjectNetInterface::addSimObjectNetInterfaceCreatorFcn ( const DtString &  type, DtSimObjectNetIfaceCreatorFcn  fcn  )

static

Adds a net interface creator function to the net interface factory. Strings are defined in netIfTypes.h.

static void makVrf::DtSimObjectNetInterface::setFactory ( DtSimObjectNetInterfaceFactory *  factory )

static

static DtSimObjectNetInterfaceFactory* makVrf::DtSimObjectNetInterface::factory ( )

static

static DtSimObjectNetInterface* makVrf::DtSimObjectNetInterface::createNetInterface ( const DtString &  type, DtStateData *  simObject, DtVrlinkNetworkInterface *  , bool  publishObject = true  )

static

Creates a new net interface object using the factory.

static int makVrf::DtSimObjectNetInterface::maxNameLengthForInterfaceType ( const DtString &  interfaceTypeString )

static

Returns

The maximum name length that will be transmitted by a network interface of the specified type.

Parameters

interfaceTypeString

must be of a type specified in vrfNetIfTypes.h

virtual void makVrf::DtSimObjectNetInterface::parallelTick ( )

virtual

Part of the parallel VRL interface, calls this to update in a parallel way.

virtual void makVrf::DtSimObjectNetInterface::forceUpdate ( )

virtual

Part of the parallel VRL interface, calls this to update in a parallel way.

Reimplemented in makVrf::DtSimLocalControlObjectNetInterface, makVrf::DtSimLocalEnvironmentalNetInterface, makVrf::DtSimAggregateLocalEntityNetInterface, and makVrf::DtSimIndividualLocalEntityNetInterface.

virtual void makVrf::DtSimObjectNetInterface::sendFinalPduOnDestruction ( bool  )

virtual

Whether or not to send the final PDU on destruction of this interface. Default is true.

Reimplemented in makVrf::DtSimIndividualLocalEntityNetInterface.

virtual void makVrf::DtSimObjectNetInterface::stateDataDestroyed ( )

protectedvirtual

bool makVrf::DtSimObjectNetInterface::runFullyThreaded ( ) const

protected

const DtStateData* makVrf::DtSimObjectNetInterface::vrfObject ( ) const

inlineprotected

DtStateData* makVrf::DtSimObjectNetInterface::nextFrameVrfObject ( )

inlineprotected

virtual const DtStateRepository* makVrf::DtSimObjectNetInterface::networkState ( ) const

protectedvirtual

this is a pointer to the VR-Link network state repository create by either the contained publisher or reflected object

bool makVrf::DtSimObjectNetInterface::isValid ( void  ) const

inline

Friends And Related Function Documentation

friend class DtVrlinkNetworkInterface

friend

friend class DtPrintObjectStatusCommand

friend

friend class DtPrintOrgViewCommand

friend

Member Data Documentation

boost::signals2::signal<void ()> makVrf::DtSimObjectNetInterface::signal_networkInterfaceDeleted

tbb::spin_rw_mutex makVrf::DtSimObjectNetInterface::thePublisherCreationMutex

static

tbb::spin_rw_mutex makVrf::DtSimObjectNetInterface::thePublisherTickMutex

static

DtStateData* makVrf::DtSimObjectNetInterface::mySimObject

protected

DtVrlinkNetworkInterface* makVrf::DtSimObjectNetInterface::myObjectManager

protected

DtStateRepository* makVrf::DtSimObjectNetInterface::myNetworkState

protected

DtSimObjectNetInterfaceFactory* makVrf::DtSimObjectNetInterface::theFactory

staticprotected

DtNonVrfUUIDResolver* makVrf::DtSimObjectNetInterface::theNonVrfUUIDResolver

staticprotected

bool makVrf::DtSimObjectNetInterface::myNeedsNetworkSetup

protected

DtNetInterfaceParallelLock makVrf::DtSimObjectNetInterface::myLock

protected

boost::signals2::connection makVrf::DtSimObjectNetInterface::mySimObjectRemovalConnection

protected

tbb::mutex makVrf::DtSimObjectNetInterface::myDeleteGuardMutex

protected

DtVrfCallbackQueue::CallbackInterface::Ptr makVrf::DtSimObjectNetInterface::myParallelContainer

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrlinkNetworkInterface/simObjectNetInterface.h