class DtLegionNetworkInterface:

The DtLegionNetworkInterface will interface with the legion network. Assumes fully initialize state data manager is passed int

Inheritance diagram for makVrf::DtLegionNetworkInterface:

[legend]

Public Member Functions
	DtLegionNetworkInterface (DtStateDataManager , Legion::Connection useConnection=0, Legion::Configuration *config=0)

virtual	~DtLegionNetworkInterface ()

virtual void	beginFrame (double) override

virtual bool	preAdvanceFrame () override

virtual void	advanceFrame (double *networkTime=nullptr) override

virtual const char *	type () const

virtual void	setInterest (const DtVector &geocentricCenter, const DtVector &ll, const DtVector &ur)

virtual void	setInterest (const DtVector &geocentricCenter, double radius)

virtual void	setInterest (const Legion::Boundary &, bool andIntent=true)

virtual void	setIntent (const Legion::Boundary &)

virtual bool	selfReflecting () const

virtual void	setSelfReflecting (bool)

virtual bool	wantsToSelfReflect (unsigned int) const

virtual bool	printDataToStream (const DtUUID &, DtOutputStream &) const

virtual const DtStateData *	stateDataForEntityId (const DtEntityIdentifier &) const

virtual const DtStateData *	stateDataForLegionId (Legion::GlobalIdentifier) const

virtual void	setRunFullyThreaded (bool)

virtual void	setEnabled (bool)

virtual void	setCoordinateSystem (const Coordinate_System *)

virtual void	setExerciseStartTime (double)

virtual bool	validateScenario (const DtScenario &, DtString &) const

virtual void	setSiteAppId (int, int)

virtual void	removeAndDeleteAll ()

virtual void	setSimTime (double)

virtual void	setTimeMultiplier (double)

virtual void	setNeedsInterestRegionSet (bool val)

virtual bool	needsInterestRegionSet () const

virtual std::string	protocol () const override

virtual void	setProcessSelfReflect (bool b)

bool	processSelfReflect () const

virtual DtRemoteObjectManager *	createRemoteObjectManager ()

virtual void	setEventManager (makVrfEvents::DtEventManager *)

makVrfEvents::DtEventManager *	eventManager ()

DtStateDataManager *	stateDataManager ()

const DtSimulationAddress &	simulationAddress () const

bool	destructing () const

virtual bool	typeIsPublishable (const DtEntityType &) const

virtual int	clientId () const

virtual UInt64	uuidToGlobalId (const DtUUID &) const

virtual DtUUID	globalIdToUUID (UInt64) const

virtual Legion::EventManager *	legionEventManager ()

virtual Legion::ControlManager *	legionControlManager ()

virtual UInt64	toGlobalIdentifier (const DtEntityIdentifier &) const

virtual DtEntityIdentifier	toEntityIdentifier (UInt64) const

virtual const makVrf::DtStateData *	stateDataForGlobalId (const DtString &) const

virtual void	setDisableRemoteDiscovery (bool)

bool	disableRemoteDiscovery () const

virtual void	setProcessRemoteObjectsInParallel (bool)

bool	processRemoteObjectsInParallel () const

virtual void	setNumCallbackThreads (unsigned)

DtLegionOwnershipTransferManager *	ownershipTransferManager ()

DtCommunicationManager *	communicationManager ()

Legion::Connection *	connection ()

DtLegionEventTranslatorManager *	eventTranslatorManager ()

virtual bool	needsUnpublishedDatabase () const

Public Member Functions inherited from DtNetworkManagerInterface
	DtNetworkManagerInterface ()

virtual	~DtNetworkManagerInterface ()

virtual double	determineSimTime (double &dt)

virtual void	beginBulkCreate ()

virtual void	endBulkCreate ()

Static Public Member Functions
static const char *	Type ()

static void	setLegionNetworkInterfaceCreatorFcn (DtLegionNetworkInterfaceCreatorFcn)

static DtLegionNetworkInterface *	createLegionNetworkInterface (DtStateDataManager , Legion::Connection connection=0, Legion::Configuration *config=0)

Protected Types
typedef boost::unordered_map < UInt64, const DtStateData * >	StateDataByEntityId

Protected Member Functions
virtual bool	stateDataAdded (DtStateData *)

virtual void	stateDataAboutToBeRemoved (const DtStateData *)

virtual bool	init (DtCommunicationManager *)

virtual void	reserve (unsigned numToReserve)

virtual void	printReflectedObjectCounts () const

virtual void	requestUpdatesForRemoteNonVrfObjects () const

virtual void	rediscoverObjects (const std::set< DtString > &ignore)

virtual unsigned int	maxNameLengthForType (const DtObjectType &) const

virtual void	startScenarioLoad (bool)

virtual void	endScenarioLoad (bool)

virtual void	setParameterDatabase (DtVrfParameterDb *)

virtual void	setVrfSessionId (int)

virtual void	setVrfMessageVersionSupported (int)

virtual void	resetSimulation ()

virtual void	rewindScenario ()

virtual void	run ()

virtual void	pause ()

virtual void	setFrameRateMode (const DtString &mode, double deltaTime, bool manageTime=false)

virtual AddEventResult	addEvent (const makVrfEvents::DtEvent &, bool &selfReflected)

virtual AddEventResult	sendEvent (const makVrfEvents::DtEvent &)

virtual bool	hasSimulationTime () const

virtual bool	rediscoverObjects ()

virtual bool	publishingOnLegionNetwork () const

Protected Attributes
DtStateDataManager *	myStateDataManager

Legion::Connection *	mySTEConnection

std::set< makVrf::SimStateID >	myPublishing

tbb::spin_rw_mutex	myPublishMutex

StateDataByEntityId	myStateDataByEntityId

bool	myNeedsInterestSet

DtSimulationAddress	mySimulationAddress

int	myAppId

int	myEntityId

makVrfEvents::DtEventManager *	myEventManager

const Coordinate_System *	myCoordinateSystem

DtLegionEventTranslatorManager *	myLegionEventTranslatorManager

bool	myOwnsLegionConnection

Legion::EventManager *	myLegionEventManager

Legion::ControlManager *	myLegionControlManager

bool	myProcessSelfReflect

DtCommunicationManager *	myCommunicationManager

DtRemoteObjectManager *	myRemoteObjectManager

bool	myDisableRemoteDiscovery

bool	myProcessRemoteObjectsInParallel

unsigned int	myNumCallbackThreads

DtLegionOwnershipTransferManager *	myOwnershipTransferManager

bool	myDestructing

Static Protected Attributes
static DtLegionNetworkInterfaceCreatorFcn	theCreatorFunction

Additional Inherited Members
Public Types inherited from DtNetworkManagerInterface
enum	AddEventResult { DoNotContinue = 0, Continue = 0x00000001 }

Member Typedef Documentation

typedef boost::unordered_map<UInt64, const DtStateData*> makVrf::DtLegionNetworkInterface::StateDataByEntityId

protected

Constructor & Destructor Documentation

makVrf::DtLegionNetworkInterface::DtLegionNetworkInterface	(	DtStateDataManager *	,
		Legion::Connection *	useConnection = `0`,
		Legion::Configuration *	config = `0`
	)

constructor

virtual makVrf::DtLegionNetworkInterface::~DtLegionNetworkInterface ( )

virtual

Member Function Documentation

virtual void makVrf::DtLegionNetworkInterface::beginFrame ( double simTime )

overridevirtual

Called when the frame is stated. The sim time passed in will be that from determineSimTime call.

Implements DtNetworkManagerInterface.

virtual bool makVrf::DtLegionNetworkInterface::preAdvanceFrame ( )

overridevirtual

Called when the frame wants to be advanced. Called before state data advance. Return false to not continue advancing frame. This can be useful if the network is still processing and the application doesn't want to block.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::advanceFrame ( double * networkFrameTime = nullptr )

overridevirtual

Called when the frame wants to be advanced and possibly process the network. If networkFrameTime is supplied, return the amount of time spent processing network messages.

Implements DtNetworkManagerInterface.

virtual const char* makVrf::DtLegionNetworkInterface::type ( ) const

inlinevirtual

Type to uniquely identify this manager.

Implements DtNetworkManagerInterface.

static const char* makVrf::DtLegionNetworkInterface::Type ( )

inlinestatic

virtual void makVrf::DtLegionNetworkInterface::setInterest	(	const DtVector &	geocentricCenter,
		const DtVector &	ll,
		const DtVector &	ur
	)

virtual

virtual void makVrf::DtLegionNetworkInterface::setInterest	(	const DtVector &	geocentricCenter,
		double	radius
	)

virtual

In case the interface wants to do interest management, the interest of this back-end.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setInterest	(	const Legion::Boundary &	,
		bool	andIntent = `true`
	)

virtual

virtual void makVrf::DtLegionNetworkInterface::setIntent ( const Legion::Boundary & )

virtual

virtual bool makVrf::DtLegionNetworkInterface::selfReflecting ( ) const

virtual

Returns true if any of the connections are self reflecting.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setSelfReflecting ( bool )

virtual

Sets all connections (if supported) to self reflecting. This will only apply to current handlers, not ones that are added after this is called.

Implements DtNetworkManagerInterface.

virtual bool makVrf::DtLegionNetworkInterface::wantsToSelfReflect ( unsigned int ) const

virtual

virtual bool makVrf::DtLegionNetworkInterface::printDataToStream	(	const DtUUID &	,
		DtOutputStream &
	)		const

virtual

Given the SimStateID, print data to the stream. Return try if the given data is published by this network interface.

Implements DtNetworkManagerInterface.

virtual const DtStateData* makVrf::DtLegionNetworkInterface::stateDataForEntityId ( const DtEntityIdentifier & ) const

virtual

Given the entity identifier, return the state data associated with it.

virtual const DtStateData* makVrf::DtLegionNetworkInterface::stateDataForLegionId ( Legion::GlobalIdentifier ) const

virtual

Given the legion global id, return the state data associated with it.

virtual void makVrf::DtLegionNetworkInterface::setRunFullyThreaded ( bool )

inlinevirtual

Whether or not to run fully threaded. Legion is always threaded.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setEnabled ( bool )

inlinevirtual

Whether or not the communication manager is enabled for receiving information.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setCoordinateSystem ( const Coordinate_System * )

virtual

Sets the coordinate system used in this simulation.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setExerciseStartTime ( double )

virtual

Start day/date time of the exercise.

Implements DtNetworkManagerInterface.

virtual bool makVrf::DtLegionNetworkInterface::validateScenario	(	const DtScenario &	,
		DtString &	error
	)		const

inlinevirtual

Return false if this scenario is not valid.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setSiteAppId	(	int	,
		int
	)

virtual

The site and app id of this back-end.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::removeAndDeleteAll ( )

virtual

Called when all objects are being deleted, will indiciate that all remotes will eventually need to be rediscovered.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setSimTime ( double )

virtual

Sets the current simulation time.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setTimeMultiplier ( double )

virtual

Sets the current time multiplier.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setNeedsInterestRegionSet ( bool val )

virtual

virtual bool makVrf::DtLegionNetworkInterface::needsInterestRegionSet ( ) const

virtual

virtual std::string makVrf::DtLegionNetworkInterface::protocol ( ) const

inlineoverridevirtual

Descriptive text of the network protocol.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setProcessSelfReflect ( bool b )

virtual

bool makVrf::DtLegionNetworkInterface::processSelfReflect ( ) const

inline

virtual DtRemoteObjectManager* makVrf::DtLegionNetworkInterface::createRemoteObjectManager ( )

virtual

static void makVrf::DtLegionNetworkInterface::setLegionNetworkInterfaceCreatorFcn ( DtLegionNetworkInterfaceCreatorFcn )

static

static DtLegionNetworkInterface* makVrf::DtLegionNetworkInterface::createLegionNetworkInterface	(	DtStateDataManager *	,
		Legion::Connection *	connection = `0`,
		Legion::Configuration *	config = `0`
	)

static

virtual void makVrf::DtLegionNetworkInterface::setEventManager ( makVrfEvents::DtEventManager * )

virtual

Sets the event manager to use process messages received from the netowkr.

Implements DtNetworkManagerInterface.

makVrfEvents::DtEventManager* makVrf::DtLegionNetworkInterface::eventManager ( )

inline

DtStateDataManager* makVrf::DtLegionNetworkInterface::stateDataManager ( )

inline

const DtSimulationAddress& makVrf::DtLegionNetworkInterface::simulationAddress ( ) const

inline

bool makVrf::DtLegionNetworkInterface::destructing ( ) const

inline

virtual bool makVrf::DtLegionNetworkInterface::typeIsPublishable ( const DtEntityType & ) const

virtual

Returns true if the entity type is publishable by this connection.

Implements DtNetworkManagerInterface.

virtual int makVrf::DtLegionNetworkInterface::clientId ( ) const

virtual

virtual UInt64 makVrf::DtLegionNetworkInterface::uuidToGlobalId ( const DtUUID & ) const

virtual

virtual DtUUID makVrf::DtLegionNetworkInterface::globalIdToUUID ( UInt64 ) const

virtual

virtual Legion::EventManager* makVrf::DtLegionNetworkInterface::legionEventManager ( )

virtual

virtual Legion::ControlManager* makVrf::DtLegionNetworkInterface::legionControlManager ( )

virtual

virtual UInt64 makVrf::DtLegionNetworkInterface::toGlobalIdentifier ( const DtEntityIdentifier & ) const

virtual

These routines make an identifier out of the entity id, this is not a legion global id.

virtual DtEntityIdentifier makVrf::DtLegionNetworkInterface::toEntityIdentifier ( UInt64 ) const

virtual

virtual const makVrf::DtStateData* makVrf::DtLegionNetworkInterface::stateDataForGlobalId ( const DtString & ) const

virtual

Given the global object designator, return the state data associated with it.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setDisableRemoteDiscovery ( bool )

virtual

Set to disable the discovery of remote objects.

bool makVrf::DtLegionNetworkInterface::disableRemoteDiscovery ( ) const

inline

virtual void makVrf::DtLegionNetworkInterface::setProcessRemoteObjectsInParallel ( bool )

virtual

Default is false.

bool makVrf::DtLegionNetworkInterface::processRemoteObjectsInParallel ( ) const

inline

virtual void makVrf::DtLegionNetworkInterface::setNumCallbackThreads ( unsigned )

virtual

If this is greater than 0 and running fully threaded, puts into thread mode where a thread is started and a number of threads are pooled for running the network interfaces. If this is 0 the main thread (in a parallel for) is used to run the network interfaces in a begin (remote) and advance (local) frame.

Implements DtNetworkManagerInterface.

DtLegionOwnershipTransferManager* makVrf::DtLegionNetworkInterface::ownershipTransferManager ( )

inline

The transfer manager. Valid after init. Get this to connect for pre transfer from message.

DtCommunicationManager* makVrf::DtLegionNetworkInterface::communicationManager ( )

inline

The communication manager.

Legion::Connection* makVrf::DtLegionNetworkInterface::connection ( )

inline

DtLegionEventTranslatorManager* makVrf::DtLegionNetworkInterface::eventTranslatorManager ( )

inline

virtual bool makVrf::DtLegionNetworkInterface::needsUnpublishedDatabase ( ) const

inlinevirtual

Return true if this connection uses the simulation database to publish on (as a legion connection does). If so then this connection will also need to let the system know it needs to provide an unpublished database.

Implements DtNetworkManagerInterface.

virtual bool makVrf::DtLegionNetworkInterface::stateDataAdded ( DtStateData * )

protectedvirtual

Called when state data is added. Return true to signal that this network interface is handling the publication of this state data and no other interface should. Called in interface insertion order.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::stateDataAboutToBeRemoved ( const DtStateData * )

protectedvirtual

Called when state data is about to be removed.

Implements DtNetworkManagerInterface.

virtual bool makVrf::DtLegionNetworkInterface::init ( DtCommunicationManager * )

protectedvirtual

Called when added to the network interface manager. Return false to not add to manager.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::reserve ( unsigned numToReserve )

protectedvirtual

No-Op.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::printReflectedObjectCounts ( ) const

protectedvirtual

Print non locally simulated object count to the screen.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::requestUpdatesForRemoteNonVrfObjects ( ) const

protectedvirtual

No-Op.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::rediscoverObjects ( const std::set< DtString > & ignore )

protectedvirtual

No-Ope.

virtual unsigned int makVrf::DtLegionNetworkInterface::maxNameLengthForType ( const DtObjectType & ) const

inlineprotectedvirtual

If the network interface supports it, the maximum name of a marking text.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::startScenarioLoad ( bool )

protectedvirtual

Called when starting scenario load. True is passed in to reuse identifiers if network dependent.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::endScenarioLoad ( bool )

inlineprotectedvirtual

Called when ending scenario load. True is passed in to reuse identifiers if network dependent.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setParameterDatabase ( DtVrfParameterDb * )

inlineprotectedvirtual

VRF specific for creating network interfaces from parameter data.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setVrfSessionId ( int )

inlineprotectedvirtual

If used, the session id this VRF session is in.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setVrfMessageVersionSupported ( int )

inlineprotectedvirtual

If used the message version this VRF session uses.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::resetSimulation ( )

protectedvirtual

Called when the simulation is ending and wants to reset.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::rewindScenario ( )

protectedvirtual

Called when the scenario is rewound.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::run ( )

protectedvirtual

Puts the simulation into run mode by letting the network connections know.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::pause ( )

protectedvirtual

Puts the simulation into pause mode by letting the network connections know.

Implements DtNetworkManagerInterface.

virtual void makVrf::DtLegionNetworkInterface::setFrameRateMode	(	const DtString &	mode,
		double	deltaTime,
		bool	manageTime = `false`
	)

protectedvirtual

Sets the mode for the exercise clock.

Implements DtNetworkManagerInterface.

virtual AddEventResult makVrf::DtLegionNetworkInterface::addEvent	(	const makVrfEvents::DtEvent &	,
		bool &	selfReflected
	)

protectedvirtual

Send this event on the network.

Implements DtNetworkManagerInterface.

virtual AddEventResult makVrf::DtLegionNetworkInterface::sendEvent ( const makVrfEvents::DtEvent & )

protectedvirtual

Sends event on network without adding to event manager if immediately self reflected.

Implements DtNetworkManagerInterface.

virtual bool makVrf::DtLegionNetworkInterface::hasSimulationTime ( ) const

inlineprotectedvirtual

This manager does not deal with sim time.

Implements DtNetworkManagerInterface.

virtual bool makVrf::DtLegionNetworkInterface::rediscoverObjects ( )

protectedvirtual

Rediscover all remote objects.

Implements DtNetworkManagerInterface.

virtual bool makVrf::DtLegionNetworkInterface::publishingOnLegionNetwork ( ) const

inlineprotectedvirtual

Whether or not this interface publishes on the legion network.

Implements DtNetworkManagerInterface.

Member Data Documentation

DtStateDataManager* makVrf::DtLegionNetworkInterface::myStateDataManager

protected

Legion::Connection* makVrf::DtLegionNetworkInterface::mySTEConnection

protected

std::set<makVrf::SimStateID> makVrf::DtLegionNetworkInterface::myPublishing

protected

tbb::spin_rw_mutex makVrf::DtLegionNetworkInterface::myPublishMutex

mutableprotected

StateDataByEntityId makVrf::DtLegionNetworkInterface::myStateDataByEntityId

protected

bool makVrf::DtLegionNetworkInterface::myNeedsInterestSet

protected

DtSimulationAddress makVrf::DtLegionNetworkInterface::mySimulationAddress

protected

int makVrf::DtLegionNetworkInterface::myAppId

protected

int makVrf::DtLegionNetworkInterface::myEntityId

protected

makVrfEvents::DtEventManager* makVrf::DtLegionNetworkInterface::myEventManager

protected

const Coordinate_System* makVrf::DtLegionNetworkInterface::myCoordinateSystem

protected

DtLegionEventTranslatorManager* makVrf::DtLegionNetworkInterface::myLegionEventTranslatorManager

protected

bool makVrf::DtLegionNetworkInterface::myOwnsLegionConnection

protected

Legion::EventManager* makVrf::DtLegionNetworkInterface::myLegionEventManager

protected

Legion::ControlManager* makVrf::DtLegionNetworkInterface::myLegionControlManager

protected

bool makVrf::DtLegionNetworkInterface::myProcessSelfReflect

protected

DtLegionNetworkInterfaceCreatorFcn makVrf::DtLegionNetworkInterface::theCreatorFunction

staticprotected

DtCommunicationManager* makVrf::DtLegionNetworkInterface::myCommunicationManager

protected

DtRemoteObjectManager* makVrf::DtLegionNetworkInterface::myRemoteObjectManager

protected

bool makVrf::DtLegionNetworkInterface::myDisableRemoteDiscovery

protected

bool makVrf::DtLegionNetworkInterface::myProcessRemoteObjectsInParallel

protected

unsigned int makVrf::DtLegionNetworkInterface::myNumCallbackThreads

protected

DtLegionOwnershipTransferManager* makVrf::DtLegionNetworkInterface::myOwnershipTransferManager

protected

bool makVrf::DtLegionNetworkInterface::myDestructing

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation