DtDDMRegion Class Reference

Instances of DtDDMRegion create an RTI region with specified dimensions. More...

Inheritance diagram for DtDDMRegion:

Collaboration diagram for DtDDMRegion:

Public Member Functions
	DtDDMRegion (DtExerciseConn *exConn)
	Constructor that creates empty shell. More...
	DtDDMRegion (DtExerciseConn *exConn, const DtString &spaceName, int numberOfExtents=1)
	Constructor that uses the specified space to create RTI region. More...
	DtDDMRegion (DtExerciseConn *exConn, const DtString &spaceName, const std::vector< DtString > &dimensionNameVector, int numberOfExtents=1)
	Constructor with that uses specified space and dimensions to create RTI region. More...
virtual	~DtDDMRegion ()
	Destructor. More...
void	init (const DtString &spaceName, const std::vector< DtString > &dimensionNameVector, int numberOfExtents=1)
	Initialize the region with the space and dimensions specified. More...
virtual void	initializeDimensions (const std::vector< DtString > &dimensionNameVector)
	Initialize the region dimensions using the specified dimension names. More...
virtual void	setUpperBound (const DtString &dimensionName, unsigned long upperBound, int extentIndex=0)
	This method sets the upper bound of dimension, specified by dimensionName, to the normalized value specified by upperBound. More...
virtual void	setLowerBound (const DtString &dimensionName, unsigned long lowerBound, int extentIndex=0)
	This method sets the lower bound of the dimension, specified by dimensionName, to the normalized value specified by lowerBound. More...
virtual void	setDimensionBounds (const DtString &dimensionName, unsigned long lowerBound, unsigned long upperBound, int extentIndex=0)
	This method sets the lower and upper bounds of the dimension,. More...
virtual void	notifyRtiOfUpdate ()
	Notify the RTI of changes to the region's extents This function will only act if a dimension has actually changed. More...
virtual void	addAttributeHandle (RTI::AttributeHandle handle)
	Add an attribute handle to the attributes associated with this region. More...
virtual void	addAttributeHandle (const DtString &objClassName, const DtString &attrName)
	Use the class and attribute names to retrieve handles then, add an attribute handle to the attributes associated with this region. More...
virtual const RTI::AttributeHandleSet &	attributeHandles () const
	Retrieve the attribute handle set associated with this region. More...
virtual int	attributeHandleCount () const
	Number of attributes associated with this region. More...
virtual bool	hasAttributeHandles () const
	Indicates if attributes have been associated with this region. More...
virtual const RTI::Region *	region () const
	Access to the RTI region representation. More...
virtual RTI::Region *	region ()
	Access to the RTI region representation. More...

Protected Member Functions
	DtDDMRegion (const DtDDMRegion &orig)
	Copy constructor – Not implemented – not allowed. More...
DtDDMRegion &	operator= (const DtDDMRegion &orig)
	Assignment operator. Not implemented – not assignable. More...

Protected Attributes
DtExerciseConn *	myExConn
DtVrlRtiAmbassador *	myRtiAmb
RTI::Region *	myRegion
std::map< DtString, RTI::DimensionHandle >	myDimensionMap
RTI::SpaceHandle	mySpaceHandle
bool	myIsDirty
RTI::AttributeHandleSet *	myAttributeHandles

Detailed Description

Instances of DtDDMRegion create an RTI region with specified dimensions.

The region can be used for subscription, associating with objects, or sending interactions.

Constructor & Destructor Documentation

DtDDMRegion::DtDDMRegion

(

DtExerciseConn *

exConn

)

Constructor that creates empty shell.

Before the extents can be modified, init must be called to specify dimensions and create RTI region. Before it can be used, extents must be set and RTI notified.

DtDDMRegion::DtDDMRegion	(	DtExerciseConn *	exConn,
		const DtString &	spaceName,
		int	numberOfExtents = 1
	)

Constructor that uses the specified space to create RTI region.

Before the extents can be modified, initializeDimensions() must be called. Before it can be used, extents must be set and RTI notified.

Exceptions

DtException

a region cannot be created

DtDDMRegion::DtDDMRegion	(	DtExerciseConn *	exConn,
		const DtString &	spaceName,
		const std::vector< DtString > &	dimensionNameVector,
		int	numberOfExtents = 1
	)

Constructor with that uses specified space and dimensions to create RTI region.

Region extents can be modified immediately. Before it can be used, extents must be set and RTI notified.

Exceptions

DtException

a region cannot be created or the dimension handles cannot be retrieved

virtual DtDDMRegion::~DtDDMRegion ( )

virtual

Destructor.

DtDDMRegion::DtDDMRegion ( const DtDDMRegion &  orig )

protected

Copy constructor – Not implemented – not allowed.

Member Function Documentation

virtual void DtDDMRegion::addAttributeHandle ( RTI::AttributeHandle  handle )

virtual

Add an attribute handle to the attributes associated with this region.

virtual void DtDDMRegion::addAttributeHandle ( const DtString &  objClassName, const DtString &  attrName  )

virtual

Use the class and attribute names to retrieve handles then, add an attribute handle to the attributes associated with this region.

Exceptions

DtException

if objClassName or attrName doesn't exist in the FOM.

virtual int DtDDMRegion::attributeHandleCount ( ) const

virtual

Number of attributes associated with this region.

virtual const RTI::AttributeHandleSet& DtDDMRegion::attributeHandles ( ) const

virtual

Retrieve the attribute handle set associated with this region.

virtual bool DtDDMRegion::hasAttributeHandles ( ) const

virtual

Indicates if attributes have been associated with this region.

void DtDDMRegion::init	(	const DtString &	spaceName,
		const std::vector< DtString > &	dimensionNameVector,
		int	numberOfExtents = 1
	)

Initialize the region with the space and dimensions specified.

Not virtual as it may be called from a constructor.

virtual void DtDDMRegion::initializeDimensions ( const std::vector< DtString > &  dimensionNameVector )

virtual

Initialize the region dimensions using the specified dimension names.

Exceptions

DtException

the dimension handle cannot be retrieved from the RTI (e.g. a name in the list is not in the FED file).

virtual void DtDDMRegion::notifyRtiOfUpdate ( )

virtual

Notify the RTI of changes to the region's extents This function will only act if a dimension has actually changed.

DtDDMRegion& DtDDMRegion::operator= ( const DtDDMRegion &  orig )

protected

Assignment operator. Not implemented – not assignable.

virtual const RTI::Region* DtDDMRegion::region ( ) const

virtual

Access to the RTI region representation.

virtual RTI::Region* DtDDMRegion::region ( )

virtual

Access to the RTI region representation.

virtual void DtDDMRegion::setDimensionBounds ( const DtString &  dimensionName, unsigned long  lowerBound, unsigned long  upperBound, int  extentIndex = 0  )

virtual

This method sets the lower and upper bounds of the dimension,.

virtual void DtDDMRegion::setLowerBound ( const DtString &  dimensionName, unsigned long  lowerBound, int  extentIndex = 0  )

virtual

This method sets the lower bound of the dimension, specified by dimensionName, to the normalized value specified by lowerBound.

Referenced by DtHyperspaceRegion< SubspaceType, DimensionType >::DtHyperspaceRegion().

virtual void DtDDMRegion::setUpperBound ( const DtString &  dimensionName, unsigned long  upperBound, int  extentIndex = 0  )

virtual

This method sets the upper bound of dimension, specified by dimensionName, to the normalized value specified by upperBound.

Referenced by DtHyperspaceRegion< SubspaceType, DimensionType >::DtHyperspaceRegion().

Member Data Documentation

RTI::AttributeHandleSet* DtDDMRegion::myAttributeHandles

protected

std::map<DtString, RTI::DimensionHandle> DtDDMRegion::myDimensionMap

protected

DtExerciseConn* DtDDMRegion::myExConn

protected

bool DtDDMRegion::myIsDirty

protected

RTI::Region* DtDDMRegion::myRegion

protected

DtVrlRtiAmbassador* DtDDMRegion::myRtiAmb

protected

RTI::SpaceHandle DtDDMRegion::mySpaceHandle

protected

---

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

• region13.h