Class Description: DtActiveSonarLocalNetInterface.

Publishes emitter found in the DtActiveSonarStateComponent passed in

There is a unified publisher in VR-Link, so, even though both of these types are added, if there are both acoustic and underwater propulsion going on, the active sonar publisher will do the unified publishing and the underwater acoustics will do nothing

Inheritance diagram for makVrf::DtActiveSonarLocalNetInterface:

[legend]

Public Member Functions
	DtActiveSonarLocalNetInterface (DtStateData simObject, DtVrlinkNetworkInterface objectManager, bool publishObject=true)

virtual	~DtActiveSonarLocalNetInterface ()

virtual bool	init (const DtStateComponent *)

virtual DtString	type () const

virtual bool	isLocal () const

virtual bool	wantsToCreatePublisher () const

Public Member Functions inherited from makVrf::DtLocalStateComponentNetInterface
	DtLocalStateComponentNetInterface (DtStateData simObject, DtVrlinkNetworkInterface objectManager, bool publishObject=true)

virtual	~DtLocalStateComponentNetInterface ()

virtual bool	isUnit () const

virtual bool	isEntity () const

virtual bool	isEnvironmental () const

virtual void	onTick ()

bool	publishObject () const

virtual bool	shouldPublish () const

Public Member Functions inherited from makVrf::DtStateComponentNetInterface
	DtStateComponentNetInterface (DtStateData simObject, DtVrlinkNetworkInterface objectManager, bool publishObject=true)

virtual	~DtStateComponentNetInterface ()

virtual void	tick ()

Public Member Functions inherited from makVrf::DtSimObjectNetInterface
	DtSimObjectNetInterface (DtStateData simObject, DtVrlinkNetworkInterface , bool publishObject=true)

virtual	~DtSimObjectNetInterface ()

virtual bool	init (const DtEntityIdentifier &id=DtEntityIdentifier())

virtual int	maxNameLength () const

virtual void	toBeRemoved ()

virtual void	parallelTick ()

virtual void	forceUpdate ()

Static Public Member Functions
static DtSimObjectNetInterface *	creator (DtStateData vrfObject, DtVrlinkNetworkInterface mgr, bool publishObject)

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 ()

Protected Member Functions
virtual void	updatePublisher ()

virtual DtObjectPublisher *	createPublisher (const DtActiveSonarStateComponent *)

virtual DtObjectPublisher *	createCombinedPublisher (const DtActiveSonarStateComponent *)

virtual void	updatePublisher (DtActiveSonarStateRepository , const DtActiveSonarStateComponent )

virtual void	updateBeam (DtActiveSonarBeamRepository , const DtActiveSonarBeamStateData )

virtual void	publishInCombinedMode (const std::vector< const DtActiveSonarStateComponent * > &, const DtUnderwaterAcousticsStateComponent *)

Protected Member Functions inherited from makVrf::DtLocalStateComponentNetInterface
virtual void	lock ()

virtual void	unlock ()

Protected Member Functions inherited from makVrf::DtStateComponentNetInterface
virtual RTI::ObjectClassHandle	objectClassHandle () const

Protected Member Functions inherited from makVrf::DtSimObjectNetInterface
bool	runFullyThreaded () const

const DtStateData *	vrfObject () const

DtStateData *	nextFrameVrfObject ()

virtual const DtStateRepository *	networkState () const

Protected Attributes
const DtActiveSonarStateComponent *	myActiveSonarComponent

bool	myInCombinedMode

Protected Attributes inherited from makVrf::DtLocalStateComponentNetInterface
bool	myPublishObject

DtObjectPublisher *	myPublisher

boost::signals2::connection	myComponentAddedConnection

boost::signals2::connection	myComponentRemovedConnection

Protected Attributes inherited from makVrf::DtStateComponentNetInterface
const DtStateComponent *	myStateComponent

Protected Attributes inherited from makVrf::DtSimObjectNetInterface
DtStateData *	mySimObject

DtVrlinkNetworkInterface *	myObjectManager

DtStateRepository *	myNetworkState

bool	myNeedsNetworkSetup

DtNetInterfaceParallelLock	myLock

Private Member Functions
	DtActiveSonarLocalNetInterface ()

	DtActiveSonarLocalNetInterface (const DtSimObjectNetInterface &orig)

const DtActiveSonarLocalNetInterface &	operator= (const DtSimObjectNetInterface &orig)

Additional Inherited Members
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::DtActiveSonarLocalNetInterface::DtActiveSonarLocalNetInterface ( )

private

default constructor

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

private

copy constructor

makVrf::DtActiveSonarLocalNetInterface::DtActiveSonarLocalNetInterface	(	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::DtActiveSonarLocalNetInterface::~DtActiveSonarLocalNetInterface ( )

virtual

destructor

Member Function Documentation

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

private

assignment operator

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

virtual

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

Reimplemented from makVrf::DtStateComponentNetInterface.

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

virtual

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

Implements makVrf::DtSimObjectNetInterface.

static DtSimObjectNetInterface* makVrf::DtActiveSonarLocalNetInterface::creator	(	DtStateData *	vrfObject,
		DtVrlinkNetworkInterface *	mgr,
		bool	publishObject
	)

static

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

inlinevirtual

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.

Reimplemented from makVrf::DtLocalStateComponentNetInterface.

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

virtual

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

Implements makVrf::DtSimObjectNetInterface.

virtual void makVrf::DtActiveSonarLocalNetInterface::updatePublisher ( )

protectedvirtual

Implements makVrf::DtLocalStateComponentNetInterface.

virtual DtObjectPublisher* makVrf::DtActiveSonarLocalNetInterface::createPublisher ( const DtActiveSonarStateComponent * )

protectedvirtual

virtual DtObjectPublisher* makVrf::DtActiveSonarLocalNetInterface::createCombinedPublisher ( const DtActiveSonarStateComponent * )

protectedvirtual

virtual void makVrf::DtActiveSonarLocalNetInterface::updatePublisher	(	DtActiveSonarStateRepository *	,
		const DtActiveSonarStateComponent *
	)

protectedvirtual

virtual void makVrf::DtActiveSonarLocalNetInterface::updateBeam	(	DtActiveSonarBeamRepository *	,
		const DtActiveSonarBeamStateData *
	)

protectedvirtual

virtual void makVrf::DtActiveSonarLocalNetInterface::publishInCombinedMode	(	const std::vector< const DtActiveSonarStateComponent * > &	,
		const DtUnderwaterAcousticsStateComponent *
	)

protectedvirtual

Member Data Documentation

const DtActiveSonarStateComponent* makVrf::DtActiveSonarLocalNetInterface::myActiveSonarComponent

protected

bool makVrf::DtActiveSonarLocalNetInterface::myInCombinedMode

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrlinkNetworkInterface/activeSonarLocalNetInterface.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation