makVrv::DtBaseConnection Class Reference

The DtBaseConnection is an abstract class. More...

Inheritance diagram for makVrv::DtBaseConnection:

Public Member Functions
	DtBaseConnection (DtSharedSettingsManager &, DtAgentManagerInterface &)
	CTOR. More...
virtual	~DtBaseConnection ()
	DTOR MUST call clearInstances first. More...
virtual void	clearInstances ()
	Clear and delete all instances rooted in the connection MUST be called before the connection is destroyed. More...
DtSharedSettingsManager &	settingsManager ()
	Get the settings manager. More...
virtual DtAgentManagerInterface &	sceneInterface ()
	Get the scene manager interface for creating drivers. More...
const DtSharedSettingsManager &	settingsManager () const
	Get the settings manager. More...
void	reportElementCreated (DtElementID id, DtElementID parentId, unsigned int type)
	Report an element created. More...
void	reportElementAttribute (DtElementID id, DtElementAttribute *attribute)
void	reportElementDestroyed (DtElementID id)
	Report an element destroyed. More...
const DtElementChanges &	currentElementChanges () const
	Look at the current element changes. More...
DtElementChanges *	takeElementChanges ()
	Take the current changes and internally start a new set of changes. More...
DtTemporaryAgentManager &	temporaryEffects ()
	Get the temporary effects manager. More...
DtBlinkingObjectManager &	blinkManager ()
	Get the blinking manager. More...
DtRandomNumberGenerator &	randomNumberGenerator ()
	Get the simulation's random number generator. More...
virtual const std::string &	tag ()
	Get the tag identifying which type of connection this is. More...
const DtUnicode &	emptyString () const
	Allocated empty string. More...
virtual DtVirtualBaseClass *	findInstance (const std::string &instanceName)
	Find an instance with the given name. More...
bool	destroyingInstances () const
	Check to see if the simulation is destroying instances. More...
virtual void	registerInstance (const std::string &instanceName, DtVirtualBaseClass *instance)
	Register an object as an instance of instanceName, and transfer memory ownership of the instance to the DtConnection. More...

Protected Types
typedef boost::unordered_map < std::string, DtVirtualBaseClass * >	InstanceMap

Protected Attributes
DtSharedSettingsManager &	mySettingsManagerCache
DtRandomNumberGenerator	myRandomNumberGenerator
DtAgentManagerInterface &	mySceneInterface
DtElementChanges *	myWorkingElementChanges
DtTemporaryAgentManager *	myTemporaryEffects
DtBlinkingObjectManager *	myBlinkManager
	Manager for blinking objects. More...
DtUnicode	myEmptyString
InstanceMap	myInstances
bool	myDestroyingInstanceFlag

Detailed Description

The DtBaseConnection is an abstract class.

Member Typedef Documentation

typedef boost::unordered_map<std::string,DtVirtualBaseClass*> makVrv::DtBaseConnection::InstanceMap

protected

Constructor & Destructor Documentation

makVrv::DtBaseConnection::DtBaseConnection	(	DtSharedSettingsManager &	,
		DtAgentManagerInterface &
	)

CTOR.

virtual makVrv::DtBaseConnection::~DtBaseConnection ( )

virtual

DTOR MUST call clearInstances first.

Member Function Documentation

virtual void makVrv::DtBaseConnection::clearInstances ( )

virtual

Clear and delete all instances rooted in the connection MUST be called before the connection is destroyed.

DtSharedSettingsManager& makVrv::DtBaseConnection::settingsManager

(

)

Get the settings manager.

virtual DtAgentManagerInterface& makVrv::DtBaseConnection::sceneInterface ( )

virtual

Get the scene manager interface for creating drivers.

const DtSharedSettingsManager& makVrv::DtBaseConnection::settingsManager

(

)

const

Get the settings manager.

void makVrv::DtBaseConnection::reportElementCreated	(	DtElementID	id,
		DtElementID	parentId,
		unsigned int	type
	)

Report an element created.

void makVrv::DtBaseConnection::reportElementAttribute	(	DtElementID	id,
		DtElementAttribute *	attribute
	)

void makVrv::DtBaseConnection::reportElementDestroyed

(

DtElementID

id

)

Report an element destroyed.

const DtElementChanges& makVrv::DtBaseConnection::currentElementChanges

(

)

const

Look at the current element changes.

DtElementChanges* makVrv::DtBaseConnection::takeElementChanges

(

)

Take the current changes and internally start a new set of changes.

DtTemporaryAgentManager& makVrv::DtBaseConnection::temporaryEffects

(

)

Get the temporary effects manager.

DtBlinkingObjectManager& makVrv::DtBaseConnection::blinkManager

(

)

Get the blinking manager.

DtRandomNumberGenerator& makVrv::DtBaseConnection::randomNumberGenerator

(

)

Get the simulation's random number generator.

virtual const std::string& makVrv::DtBaseConnection::tag ( )

inlinevirtual

Get the tag identifying which type of connection this is.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection.

const DtUnicode& makVrv::DtBaseConnection::emptyString

(

)

const

Allocated empty string.

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

virtual

Find an instance with the given name.

If no instance is found than a null pointer is returned

Warning

This function will always return 0 when the simulation is in the process of destroying all instances, this allows some what save access to findInstance in object destructors.

Reimplemented in makVrv::DtIntervisibilityDriver::DtIntervisibilityConnection.

Referenced by makVrf::VRF_PROTOCOL_NAMESPACE::DtEnvironmentSimDataProcessor::findInstance(), makVrv::DT_PROTOCOL_NAMESPACE::DtSensorFieldOfViewSimDataProcessor::findInstance(), makVrf::VRF_PROTOCOL_NAMESPACE::DtActiveSonarSimDataProcessor::findInstance(), makVrf::VRF_PROTOCOL_NAMESPACE::DtEmitterSystemSimDataProcessor::findInstance(), makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfWeatherStateProcessor::findInstance(), makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfCloudLayerStateProcessor::findInstance(), and makVrv::DT_PROTOCOL_NAMESPACE::DtInteractionListener< InteractionClass >::instance().

bool makVrv::DtBaseConnection::destroyingInstances ( ) const

inline

Check to see if the simulation is destroying instances.

This function is used in the destructor of objects which access instances via reference which may throw an exception.

*  TestClass::~TestClass()
*  {
*     if(!mySimulation.destroyingInstances())
*     {
*         //Safe to get instance now.
*         Singleton& anInstance = Singleton::instance(mySimulation);
*         ...
*     }
*  

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

virtual

Register an object as an instance of instanceName, and transfer memory ownership of the instance to the DtConnection.

Reimplemented in makVrv::DtIntervisibilityDriver::DtIntervisibilityConnection.

Referenced by makVrv::DT_PROTOCOL_NAMESPACE::DtInteractionListener< InteractionClass >::instance(), makVrf::VRF_PROTOCOL_NAMESPACE::DtEnvironmentSimDataProcessor::registerInstance(), makVrv::DT_PROTOCOL_NAMESPACE::DtSensorFieldOfViewSimDataProcessor::registerInstance(), makVrf::VRF_PROTOCOL_NAMESPACE::DtActiveSonarSimDataProcessor::registerInstance(), makVrf::VRF_PROTOCOL_NAMESPACE::DtEmitterSystemSimDataProcessor::registerInstance(), makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfWeatherStateProcessor::registerInstance(), and makVrf::VRF_PROTOCOL_NAMESPACE::DtVrfCloudLayerStateProcessor::registerInstance().

Member Data Documentation

DtSharedSettingsManager& makVrv::DtBaseConnection::mySettingsManagerCache

protected

DtRandomNumberGenerator makVrv::DtBaseConnection::myRandomNumberGenerator

protected

DtAgentManagerInterface& makVrv::DtBaseConnection::mySceneInterface

protected

DtElementChanges* makVrv::DtBaseConnection::myWorkingElementChanges

protected

DtTemporaryAgentManager* makVrv::DtBaseConnection::myTemporaryEffects

protected

DtBlinkingObjectManager* makVrv::DtBaseConnection::myBlinkManager

protected

Manager for blinking objects.

DtUnicode makVrv::DtBaseConnection::myEmptyString

protected

InstanceMap makVrv::DtBaseConnection::myInstances

protected

bool makVrv::DtBaseConnection::myDestroyingInstanceFlag

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvCore/DtBaseConnection.h