DtDDMRegion Class Reference

Inheritance diagram for DtDDMRegion:

Collaboration diagram for DtDDMRegion:

List of all members.

Classes
struct	DtDimensionHandleBoundsStruct
Public Member Functions
	DtDDMRegion (DtExerciseConn *exConn)
	Constructor that only takes exConn.
	DtDDMRegion (DtExerciseConn *exConn, const std::vector< DtString > &dimensionNameVector)
	Constructor that specifies the dimensions.
	DtDDMRegion (DtExerciseConn *exConn, const RTI::RegionHandle &region)
	DtDDMRegion (const DtDDMRegion &orig)
	Copy constructor.
virtual	~DtDDMRegion ()
	Destructor.
virtual void	initializeDimensions (const std::vector< DtString > &dimensionNameVector)
	Initializes dimensions passed in.
virtual void	initializeDimensions (const RTI::DimensionHandleSet &dimHandles)
virtual void	setUpperBound (const DtString &dimensionName, unsigned long upperBound)
	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)
	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)
virtual void	notifyRtiOfUpdate ()
virtual RTI::RegionHandle	regionHandle ()
	I don't like this, as it exposes the region*.
virtual const RTI::RegionHandle	regionHandle () const
virtual void	init (const std::vector< DtString > &dimensionNameVector)
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 const RTI::AttributeHandleSet &	attributeHandles () const
virtual bool	hasAttributeHandles () const
virtual int	attributeHandleCount () const
bool	operator< (const DtDDMRegion &other) const
Protected Member Functions
virtual void	createRegion ()
	Utility function that actually creates the region and stores the handle.
DtDDMRegion &	operator= (const DtDDMRegion &orig)
	Assignment operator. Not implemented -- not assignable.
Protected Attributes
RTI::RegionHandle	myRegionHandle
DtVrlRtiAmbassador *	myRtiAmb
std::map< DtString, DtDimensionHandleBoundsStruct >	myDimensionMap
DtExerciseConn *	myExConn
RTI::AttributeHandleSet *	myAttributeHandles

---

Constructor & Destructor Documentation

DtDDMRegion::DtDDMRegion

(

DtExerciseConn *

exConn

)

Constructor that only takes exConn.

Init must be called before using.

DtDDMRegion::DtDDMRegion	(	DtExerciseConn *	exConn,
		const std::vector< DtString > &	dimensionNameVector
	)

Constructor that specifies the dimensions.

The number of dimensions is determined from the size() method of the vector passed in.

Exceptions:

DtException

the region cannot be created

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

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 void DtDDMRegion::createRegion

(

)

[protected, virtual]

Utility function that actually creates the region and stores the handle.

The dimensions need to be initialized before this call is made.

Exceptions:

DtException

if the region cannot be created

virtual bool DtDDMRegion::hasAttributeHandles

(

)

const [virtual]

virtual void DtDDMRegion::init

(

const std::vector< DtString > &

dimensionNameVector

)

[virtual]

virtual void DtDDMRegion::initializeDimensions

(

const std::vector< DtString > &

dimensionNameVector

)

[virtual]

Initializes dimensions passed in.

Retrieves the dimension handles from the RTI and adds them to the internal mapping.

Exceptions:

DtException

dimension handles cannot be retrieved.

virtual void DtDDMRegion::initializeDimensions

(

const RTI::DimensionHandleSet &

dimHandles

)

[virtual]

virtual void DtDDMRegion::notifyRtiOfUpdate

(

)

[virtual]

bool DtDDMRegion::operator<

(

const DtDDMRegion &

other

)

const

DtDDMRegion& DtDDMRegion::operator=

(

const DtDDMRegion &

orig

)

[protected]

Assignment operator. Not implemented -- not assignable.

virtual RTI::RegionHandle DtDDMRegion::regionHandle

(

)

[virtual]

I don't like this, as it exposes the region*.

virtual const RTI::RegionHandle DtDDMRegion::regionHandle

(

)

const [virtual]

virtual void DtDDMRegion::setDimensionBounds	(	const DtString &	dimensionName,
		unsigned long	lowerBound,
		unsigned long	upperBound
	)		[virtual]

virtual void DtDDMRegion::setLowerBound	(	const DtString &	dimensionName,
		unsigned long	lowerBound
	)		[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
	)		[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, DtDimensionHandleBoundsStruct> DtDDMRegion::myDimensionMap [protected]

DtExerciseConn* DtDDMRegion::myExConn [protected]

RTI::RegionHandle DtDDMRegion::myRegionHandle [protected]

DtVrlRtiAmbassador* DtDDMRegion::myRtiAmb [protected]

---

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

• region1516.h