The base class for protocol specific VRLink Simulations.

Inheritance diagram for makVrv::DtVrlinkBaseConnection:

Public Member Functions
	DtVrlinkBaseConnection (DtAgentManagerInterface &aSceneInterface, const DtCoordinateSystem &coordSystem, const DtEntityAppearanceMapperFactoryCreator &appFactoryCreator, DtSharedSettingsManager &settingsManager)

virtual	~DtVrlinkBaseConnection ()

	DtVrlinkBaseConnection ()=delete

	DtVrlinkBaseConnection (const DtVrlinkBaseConnection &)=delete

DtVrlinkBaseConnection &	operator= (const DtVrlinkBaseConnection &)=delete

const DtEntityAppearanceMapper *	findAppearanceMapper (const DtEntityType &type)

const DtEntityAppearanceMapperFactory &	appearanceMapperFactory () const

virtual void	setWorldMagneticModel (DtWorldMagneticModel *magModel)

virtual DtWorldMagneticModel *const	worldMagneticModel () const

virtual DtWorldMagneticModel *	worldMagneticModel ()

virtual const DtDisplayUnitsConverter &	displayUnitsConverter () const

virtual void	createDisplayUnitsConverter ()

virtual bool	connect ()=0

virtual bool	connected () const

virtual bool	disconnect ()=0

virtual void	tick (double dt)=0

virtual double	simTime () const =0

virtual void	setSimTime (double simTime)=0

virtual double	clockTime () const =0

virtual DtTimeStampType	timeStampType () const =0

virtual void	pauseConnection ()

virtual void	resumeConnection ()

virtual bool	connectionIsPaused () const

virtual void	setViewControlChanged (bool enabled)=0

virtual void	setConnectionFrameTime (double frameTime)=0

virtual double	connectionFrameTime () const =0

virtual void	setUseTopoForFlatEarthVectorConversion (bool enabled)=0

virtual void	observerUpdated (const std::string &observerName, double x, double y, double z, double psi, double theta, double phi)=0

virtual void	observerUpdated (const std::string &observerName, double x, double y, double z, double psi, double theta, double phi, double dx, double dy, double dz, double dpsi, double dtheta, double dphi)=0

virtual void	stopPublishingObserver (const std::string &observerName)=0

virtual void	startPublishingObserver (const std::string &observerName)=0

void	setAppNumber (int appNumber)

void	setSiteId (int siteId)

virtual bool	isDisconnecting () const

Public Member Functions inherited from makVrv::DtBaseConnection
	DtBaseConnection (DtSharedSettingsManager &settingsManager, DtAgentManagerInterface &aSceneInterface, const DtCoordinateSystem &coordSystem)

	DtBaseConnection (DtSharedSettingsManager &settingsManager, DtAgentManagerInterface &aSceneInterface)

virtual	~DtBaseConnection ()

virtual void	clearInstances ()

virtual void	coordinateSystemChanged (const std::string &coordinateName, const std::string &coordinateOrigin)

const DtCoordinateSystem &	coordinateSystem () const

DtSharedSettingsManager &	settingsManager ()

virtual DtAgentManagerInterface &	sceneInterface ()

const DtSharedSettingsManager &	settingsManager () const

DtVisualizerCreationSettings &	visualizerCreationSettings ()

void	reportElementCreated (DtElementID id, DtElementID parentId, unsigned int type)

void	reportElementAttribute (DtElementID id, DtElementAttribute *attribute)

void	reportElementDestroyed (DtElementID id)

const DtElementChanges &	currentElementChanges () const

DtElementChanges *	takeElementChanges ()

DtTemporaryAgentManager &	temporaryEffects ()

DtBlinkingObjectManager &	blinkManager ()

DtRandomNumberGenerator &	randomNumberGenerator ()

virtual const std::string &	tag ()

const DtUnicode &	emptyString () const

virtual DtVirtualBaseClass *	findInstance (const std::string &instanceName)

bool	destroyingInstances () const

virtual void	registerInstance (const std::string &instanceName, DtVirtualBaseClass *instance)

Public Attributes
boost::signalslib::signal < void(DtViewStateProcessor::ObserverAction &)>	signal_viewChanged

boost::signalslib::signal< void()>	signal_connected

boost::signalslib::signal< void()>	signal_toBeDisconnected

Public Attributes inherited from makVrv::DtBaseConnection
vrvSignalsLib::signal< void()>	signal_coordinateSystemChanged

boost::signalslib::signal< void()>	signal_preConnectionTick

boost::signalslib::signal< void()>	signal_postConnectionTick

Protected Member Functions
virtual void	slot_dateChanged (int year, DtDeTimeManager::Month month, int day)

Protected Attributes
DtEntityAppearanceMapperFactory *	myMapperFactory

DtWorldMagneticModel *	myWorldMagneticModel

DtDisplayUnitsConverter *	myCoordinateConverter

boost::signalslib::connection	myDateTimeSignalConnection

int	myAppNumber

int	mySiteId

bool	myIsPausedFlag

bool	myIsDisconnecting

Protected Attributes inherited from makVrv::DtBaseConnection
DtSharedSettingsManager &	mySettingsManagerCache

DtRandomNumberGenerator	myRandomNumberGenerator

DtAgentManagerInterface &	mySceneInterface

DtElementChanges *	myWorkingElementChanges

DtTemporaryAgentManager *	myTemporaryEffects

DtBlinkingObjectManager *	myBlinkManager

DtUnicode	myEmptyString

InstanceMap	myInstances

bool	myDestroyingInstanceFlag

DtCoordinateSystem *	myCoordinateSystem

DtVisualizerCreationSettings *	myVisualizerCreationSettings

Additional Inherited Members
Protected Types inherited from makVrv::DtBaseConnection
using	InstanceMap = std::unordered_map< std::string, DtVirtualBaseClass * >

Constructor & Destructor Documentation

makVrv::DtVrlinkBaseConnection::DtVrlinkBaseConnection	(	DtAgentManagerInterface &	aSceneInterface,
		const DtCoordinateSystem &	coordSystem,
		const DtEntityAppearanceMapperFactoryCreator &	appFactoryCreator,
		DtSharedSettingsManager &	settingsManager
	)

CTOR.

virtual makVrv::DtVrlinkBaseConnection::~DtVrlinkBaseConnection ( )

virtual

DTOR.

makVrv::DtVrlinkBaseConnection::DtVrlinkBaseConnection ( )

delete

not allowed - default constructor

makVrv::DtVrlinkBaseConnection::DtVrlinkBaseConnection ( const DtVrlinkBaseConnection & )

delete

not allowed - copy constructor

Member Function Documentation

DtVrlinkBaseConnection& makVrv::DtVrlinkBaseConnection::operator= ( const DtVrlinkBaseConnection & )

delete

not allowed - equals operator

const DtEntityAppearanceMapper* makVrv::DtVrlinkBaseConnection::findAppearanceMapper ( const DtEntityType & type )

Attempt to get an appearance mapper from an entity type.

const DtEntityAppearanceMapperFactory& makVrv::DtVrlinkBaseConnection::appearanceMapperFactory ( ) const

virtual void makVrv::DtVrlinkBaseConnection::setWorldMagneticModel ( DtWorldMagneticModel * magModel )

virtual

When the VR-Link driver creates this connection it provides a clone of it's DtWorldMagneticModel, which is then taken over by the connection (the connection will delete it in it's destructor. We do it this way (instead of creating our own magnetic model because the cloned model from the DtDe will be current as far as any date changes, and the connection does not have direct access to the DtDeTimeManager for initialization.

virtual DtWorldMagneticModel* const makVrv::DtVrlinkBaseConnection::worldMagneticModel ( ) const

virtual

Get this connection's DtWorldMagneticModel instance. Note that this may return null if the world magnetic model has not been set.

virtual DtWorldMagneticModel* makVrv::DtVrlinkBaseConnection::worldMagneticModel ( )

virtual

virtual const DtDisplayUnitsConverter& makVrv::DtVrlinkBaseConnection::displayUnitsConverter ( ) const

virtual

get the display units converter for this connection

virtual void makVrv::DtVrlinkBaseConnection::createDisplayUnitsConverter ( )

virtual

Create a DtDisplayUnitsConverter, using the connection's DtWorldMagneticModel copy.

virtual bool makVrv::DtVrlinkBaseConnection::connect ( )

pure virtual

Function that creates the exercise conn and reflected lists.

Returns: if connect succeeds

Return values

true	success
false	failure

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual bool makVrv::DtVrlinkBaseConnection::connected ( ) const

virtual

Check to see if the simulation is connected. Base version always returns false.

Reimplemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual bool makVrv::DtVrlinkBaseConnection::disconnect ( )

pure virtual

Function that destroys the exercise conn and reflected lists.

Returns: if connect succeeds

Return values

true	success
false	failure

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtVrlinkBaseConnection::tick ( double dt )

pure virtual

Function to be called repeatedly by a thread.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual double makVrv::DtVrlinkBaseConnection::simTime ( ) const

pure virtual

Get the current simulation time from the connection's vrlink exercise connection.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtVrlinkBaseConnection::setSimTime ( double simTime )

pure virtual

Set the current simulation time to the connection's vrlink exercise connection.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual double makVrv::DtVrlinkBaseConnection::clockTime ( ) const

pure virtual

Get the current clock time (absRealTime()) from the connection's vrlink exercise connection.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual DtTimeStampType makVrv::DtVrlinkBaseConnection::timeStampType ( ) const

pure virtual

Get the timestamp type in use (Relative or Absolute) by the connection's vrlink exercise connection.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtVrlinkBaseConnection::pauseConnection ( )

virtual

Inform the connection that we are paused (sets the myIsPausedFlag to true)

virtual void makVrv::DtVrlinkBaseConnection::resumeConnection ( )

virtual

Inform the connection that we should resume (sets the myIsPausedFlag to false)

virtual bool makVrv::DtVrlinkBaseConnection::connectionIsPaused ( ) const

virtual

Check to see if the connection is paused.

virtual void makVrv::DtVrlinkBaseConnection::setViewControlChanged ( bool enabled )

pure virtual

Set that the view controls have changed.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtVrlinkBaseConnection::setConnectionFrameTime ( double frameTime )

pure virtual

Set the connection frame time. This is 1/frequency for the connection tick. Default is 1/60.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual double makVrv::DtVrlinkBaseConnection::connectionFrameTime ( ) const

pure virtual

Get the connection frame time. This is 1/frequency for the connection tick. Default is 1/60.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtVrlinkBaseConnection::setUseTopoForFlatEarthVectorConversion ( bool enabled )

pure virtual

We used to use a topo system to convert flat earth vectors. Now we find the point at the end of the vector, convert start and end points, and subtract for a more accurate result. However, when receiving data from a sim using the old method (including older versions of VR-Forces and DI-Guy) user's may want to revert to the old scheme.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtVrlinkBaseConnection::observerUpdated	(	const std::string &	observerName,
		double	x,
		double	y,
		double	z,
		double	psi,
		double	theta,
		double	phi
	)

pure virtual

handle observer position and orientation changes

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtVrlinkBaseConnection::observerUpdated	(	const std::string &	observerName,
		double	x,
		double	y,
		double	z,
		double	psi,
		double	theta,
		double	phi,
		double	dx,
		double	dy,
		double	dz,
		double	dpsi,
		double	dtheta,
		double	dphi
	)

pure virtual

handle observer poistion and orientation changes including rotational and linear velocities

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtVrlinkBaseConnection::stopPublishingObserver ( const std::string & observerName )

pure virtual

Start publishing an observer.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

virtual void makVrv::DtVrlinkBaseConnection::startPublishingObserver ( const std::string & observerName )

pure virtual

Stop publishing an observer.

Implemented in makVrv::DtLegionConnection, and makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

void makVrv::DtVrlinkBaseConnection::setAppNumber ( int appNumber )

Set the application number (for HLA connections only, DIS should use the initializer)

void makVrv::DtVrlinkBaseConnection::setSiteId ( int siteId )

Set the site ID (useful for HLA connections only, DIS connections should use the initializer)

virtual bool makVrv::DtVrlinkBaseConnection::isDisconnecting ( ) const

virtual

Access flag to check if we are disconnecting. A signal is raised when the connection is being disconnected, which many objects listen to. However, sometimes one object needs to know that it should ignore something it's being asked to do, even if it hasn't received the signal yet (because the asker has). One example of this is the deletion of entities causing hidden aggregates to show themselves when they become childless. We really don't want that behavior if the reason it becomes childless is that we are shutting down. So when it's last child is deleted, it can check this flag and decide not to show itself in this circumstance.

virtual void makVrv::DtVrlinkBaseConnection::slot_dateChanged	(	int	year,
		DtDeTimeManager::Month	month,
		int	day
	)

protectedvirtual

Listen for (event) signals from the DtDeTimeManagerSignal so we can keep our DtWorldMagneticModel copy up-to-date.

Member Data Documentation

boost::signalslib::signal<void (DtViewStateProcessor::ObserverAction&)> makVrv::DtVrlinkBaseConnection::signal_viewChanged

Emitted when a view control change is received.

boost::signalslib::signal<void ()> makVrv::DtVrlinkBaseConnection::signal_connected

Emitted when the connection finished connecting.

boost::signalslib::signal<void ()> makVrv::DtVrlinkBaseConnection::signal_toBeDisconnected

Emitted when the connection will be disconnecting.

DtEntityAppearanceMapperFactory* makVrv::DtVrlinkBaseConnection::myMapperFactory

protected

Factory responsible for creating Appearance Mappers.

DtWorldMagneticModel* makVrv::DtVrlinkBaseConnection::myWorldMagneticModel

protected

DtDisplayUnitsConverter* makVrv::DtVrlinkBaseConnection::myCoordinateConverter

protected

boost::signalslib::connection makVrv::DtVrlinkBaseConnection::myDateTimeSignalConnection

protected

int makVrv::DtVrlinkBaseConnection::myAppNumber

protected

int makVrv::DtVrlinkBaseConnection::mySiteId

protected

bool makVrv::DtVrlinkBaseConnection::myIsPausedFlag

protected

bool makVrv::DtVrlinkBaseConnection::myIsDisconnecting

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrvVrl/DtVrlinkBaseConnection.h

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation