DtDDMRegion Class Reference

Inheritance diagram for DtDDMRegion:

Collaboration diagram for DtDDMRegion:

Public Member Functions
	DtDDMRegion (DtExerciseConn *exConn)
	Constructor that only takes the exConn.
	DtDDMRegion (DtExerciseConn *exConn, const DtString &spaceName, int numberOfExtents=1)
	Constructor with space specified.
	DtDDMRegion (DtExerciseConn *exConn, const DtString &spaceName, const std::vector< DtString > &dimensionNameVector, int numberOfExtents=1)
	Constructor with space and dimensions specified.
	DtDDMRegion (DtExerciseConn *exConn, const RTI::Region &region)
	Constructor that initializes VR-Link object from RTI 13 Region pointer.
	DtDDMRegion (const DtDDMRegion &orig)
	Copy constructor.
virtual	~DtDDMRegion ()
	Destructor.
virtual void	initializeDimensions (const std::vector< DtString > &dimensionNameVector)
	Sets up the region for the dimensions specified by name in dimensionNameList.
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.
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.
virtual void	setDimensionBounds (const DtString &dimensionName, unsigned long lowerBound, unsigned long upperBound, int extentIndex=0)
virtual void	notifyRtiOfUpdate ()
void	init (const DtString &spaceName, const std::vector< DtString > &dimensionNameVector, int numberOfExtents=1)
	Initialize the region with the name a dimensions specified.
virtual const RTI::Region *	region () const
	Returns the RTI region.
virtual RTI::Region *	region ()
virtual void	addAttributeHandle (RTI::AttributeHandle handle)
virtual void	addAttributeHandle (const DtString &objClassName, const DtString &attrName)
	Add an attribute to the handle set by class name/attribute name.
virtual int	attributeHandleCount () const
virtual const RTI::AttributeHandleSet &	attributeHandles () const
virtual bool	hasAttributeHandles () const
DtDDMRegion &	operator= (const DtDDMRegion &orig)
	Assignment operator.

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

Constructor & Destructor Documentation

DtDDMRegion::DtDDMRegion

(

DtExerciseConn *

exConn

)

Constructor that only takes the exConn.

Init must be called before using.

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

Constructor with space specified.

Creates a region with space as specified. Note that initializeDimensions() must be called before setting bounds of the region if this constructor is used

Exceptions

DtException

a region cannot be created

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

Constructor with space and dimensions specified.

Creates a region in the space specified and initializes the dimensions specified. Creates a region that is "ready to go," i.e. is ready to be modified.

Exceptions

DtException

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

DtDDMRegion::DtDDMRegion	(	DtExerciseConn *	exConn,
		const RTI::Region &	region
	)

Constructor that initializes VR-Link object from RTI 13 Region pointer.

Prefer the other constructors.

DtDDMRegion::DtDDMRegion

(

const DtDDMRegion &

orig

)

Copy constructor.

virtual DtDDMRegion::~DtDDMRegion ( )

virtual

Destructor.

Member Function Documentation

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

virtual

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

virtual

Add an attribute to the handle set by class name/attribute name.

Exceptions

DtException

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

virtual int DtDDMRegion::attributeHandleCount ( ) const

virtual

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

virtual

virtual bool DtDDMRegion::hasAttributeHandles ( ) const

virtual

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

Initialize the region with the name a dimensions specified.

Not virtual as it may be called from a constructor.

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

virtual

Sets up the region for the dimensions specified by name in dimensionNameList.

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

DtDDMRegion& DtDDMRegion::operator=

(

const DtDDMRegion &

orig

)

Assignment operator.

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

virtual

Returns the RTI region.

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

virtual

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

virtual

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

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