makVrf::DtStateComponentNetInterface Class Reference

Class Description: DtStateComponentNetInterface.

DtStateComponentNetInterface is a base class for net interfaces that simply deal with components that are part of a state data

Inheritance diagram for makVrf::DtStateComponentNetInterface:

Public Member Functions
	DtStateComponentNetInterface (DtStateData *simObject, DtVrlinkNetworkInterface *objectManager, bool publishObject=true)
virtual	~DtStateComponentNetInterface () override
virtual bool	init (const DtStateComponent *)
virtual bool	isUnit () const override
virtual bool	isEntity () const override
virtual bool	isEnvironmental () const override
virtual bool	publishObject () const override
virtual void	tick () override
Public Member Functions inherited from makVrf::DtSimObjectNetInterface
DtVrfCallbackQueue::CallbackInterface::Ptr	parallelContainer ()
	DtSimObjectNetInterface (DtStateData *simObject, DtVrlinkNetworkInterface *, bool publishObject=true)
virtual	~DtSimObjectNetInterface ()
virtual bool	init (const DtEntityIdentifier &id=DtEntityIdentifier())
virtual bool	init (DtHlaObjectWithStateRep *obj, DtHlaObjectWithStateRep *extendedAttributes=nullptr)
virtual void	onTick ()=0
virtual bool	wantsToCreatePublisher () const =0
virtual bool	isLocal () const =0
virtual DtString	type () const =0
virtual int	maxNameLength () const
virtual void	toBeRemoved ()
virtual void	sendFinalPduOnDestruction (bool)
bool	isValid () const
virtual std::vector < DtGlobalObjectDesignator >	associatedGlobalObjectDesignators () const
virtual void	parallelTick ()
virtual void	forceUpdate ()

Protected Member Functions
virtual RTI::ObjectClassHandle	objectClassHandle () const override
Protected Member Functions inherited from makVrf::DtSimObjectNetInterface
virtual void	stateDataDestroyed ()
bool	runFullyThreaded () const
const DtStateData *	vrfObject () const
DtStateData *	nextFrameVrfObject ()
virtual const DtStateRepository *	networkState () const

Protected Attributes
const DtStateComponent *	myStateComponent
Protected Attributes inherited from makVrf::DtSimObjectNetInterface
DtStateData *	mySimObject
DtVrlinkNetworkInterface *	myObjectManager
DtStateRepository *	myNetworkState
bool	myNeedsNetworkSetup
DtNetInterfaceParallelLock	myLock
boost::signals2::connection	mySimObjectRemovalConnection
tbb::mutex	myDeleteGuardMutex
DtVrfCallbackQueue::CallbackInterface::Ptr	myParallelContainer

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

Additional Inherited Members
Static Public Member Functions inherited from makVrf::DtSimObjectNetInterface
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 inherited from makVrf::DtSimObjectNetInterface
boost::signals2::signal< void()>	signal_networkInterfaceDeleted
Static Public Attributes inherited from makVrf::DtSimObjectNetInterface
static tbb::spin_rw_mutex	thePublisherCreationMutex
static tbb::spin_rw_mutex	thePublisherTickMutex
Static Protected Attributes inherited from makVrf::DtSimObjectNetInterface
static DtSimObjectNetInterfaceFactory *	theFactory
static DtNonVrfUUIDResolver *	theNonVrfUUIDResolver

Constructor & Destructor Documentation

makVrf::DtStateComponentNetInterface::DtStateComponentNetInterface ( )

private

default constructor

makVrf::DtStateComponentNetInterface::DtStateComponentNetInterface ( const DtStateComponentNetInterface &  orig )

private

copy constructor

makVrf::DtStateComponentNetInterface::DtStateComponentNetInterface	(	DtStateData *	simObject,
		DtVrlinkNetworkInterface *	objectManager,
		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::DtStateComponentNetInterface::~DtStateComponentNetInterface ( )

overridevirtual

destructor

Member Function Documentation

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

private

assignment operator

virtual bool makVrf::DtStateComponentNetInterface::init ( const DtStateComponent *  )

virtual

Derived classes that need to perform virtual construction my override this function as desired. The state component passed in is the state component that will be published from.

Reimplemented in makVrf::DtTaskVisualizationLocalNetInterface, makVrf::DtActiveSonarLocalNetInterface, makVrf::DtAirTurbulenceLocalNetInterface, makVrf::DtIffLocalNetInterface, makVrf::DtWindCorridorLocalNetInterface, makVrf::DtEmitterSystemLocalNetInterface, makVrf::DtTimeAndDateLocalNetInterface, makVrf::DtUnderwaterAcousticsLocalNetInterface, makVrf::DtDynamicTerrainLocalNetInterface, makVrf::DtRadioTransmitterLocalNetInterface, makVrf::DtRadioReceiverLocalNetInterface, makVrf::DtSensorFieldOfViewLocalNetInterface, and makVrf::DtLaserDesignatorLocalNetInterface.

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

inlineoverridevirtual

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

Implements makVrf::DtSimObjectNetInterface.

Reimplemented in makVrf::DtRemoteStateComponentNetInterface, and makVrf::DtLocalStateComponentNetInterface.

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

inlineoverridevirtual

Implements makVrf::DtSimObjectNetInterface.

Reimplemented in makVrf::DtRemoteStateComponentNetInterface, and makVrf::DtLocalStateComponentNetInterface.

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

inlineoverridevirtual

Implements makVrf::DtSimObjectNetInterface.

Reimplemented in makVrf::DtRemoteStateComponentNetInterface, and makVrf::DtLocalStateComponentNetInterface.

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

inlineoverridevirtual

Reimplemented from makVrf::DtSimObjectNetInterface.

Reimplemented in makVrf::DtLocalStateComponentNetInterface.

virtual void makVrf::DtStateComponentNetInterface::tick ( )

overridevirtual

Calls onTick()

Reimplemented from makVrf::DtSimObjectNetInterface.

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

overrideprotectedvirtual

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

Implements makVrf::DtSimObjectNetInterface.

Member Data Documentation

const DtStateComponent* makVrf::DtStateComponentNetInterface::myStateComponent

protected

---

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

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