DtDDMRegion Class Reference

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

Inheritance diagram for DtDDMRegion:

Collaboration diagram for DtDDMRegion:

Classes
struct	DtDimensionHandleBoundsStruct

Public Member Functions
	DtDDMRegion (DtExerciseConn *exConn)
	Constructor that creates empty shell.
	DtDDMRegion (DtExerciseConn *exConn, const std::vector< DtString > &dimensionNameVector)
	Constructor that uses specified dimensions to create RTI region.
virtual	~DtDDMRegion ()
	Destructor.
virtual void	init (const std::vector< DtString > &dimensionNameVector)
	Initialize the dimensions and create the RTI region.
virtual void	initializeDimensions (const std::vector< DtString > &dimensionNameVector)
	Initializes the specified dimensions.
virtual void	initializeDimensions (const RTI::DimensionHandleSet &dimHandles)
	Initialize the internal mapping using the specified dimension handles.
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)
	This method sets the lower and upper bounds of the dimension, specified by dimensionName, to the normalized value specified by bounds.
virtual void	notifyRtiOfUpdate ()
	Notify the RTI of changes to the region's extents.
virtual void	addAttributeHandle (RTI::AttributeHandle handle)
	Add an attribute to the handle to the attributes associated with this region.
virtual void	addAttributeHandle (const DtString &objClassName, const DtString &attrName)
	Add an attribute to the handle to the attributes associated with this region.
virtual const RTI::AttributeHandleSet &	attributeHandles () const
	Retrieve the attribute handle set associated with this region.
virtual int	attributeHandleCount () const
	Number of attributes associated with this region.
virtual bool	hasAttributeHandles () const
	Indicates if attributes have been associated with this region.
virtual RTI::RegionHandle	regionHandle ()
	Access to the RTI region representation.
virtual const RTI::RegionHandle	regionHandle () const
	Access to the RTI region representation.

Protected Member Functions
virtual void	createRegion ()
	Utility function that actually creates the region and stores the handle.
	DtDDMRegion (const DtDDMRegion &orig)
	Copy constructor – Not implemented – not allowed.
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

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 it can be used, init must be called to specify dimensions and create RTI region.

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

Constructor that uses specified dimensions to create RTI region.

Exceptions

DtException

the region cannot be created

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 to the handle to the attributes associated with this region.

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

virtual

Add an attribute to the 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 void DtDDMRegion::createRegion ( )

protectedvirtual

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

Indicates if attributes have been associated with this region.

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

virtual

Initialize the dimensions and create the RTI region.

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

virtual

Initializes the specified dimensions.

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

Initialize the internal mapping using the specified dimension handles.

virtual void DtDDMRegion::notifyRtiOfUpdate ( )

virtual

Notify the RTI of changes to the region's extents.

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

protected

Assignment operator. Not implemented – not assignable.

virtual RTI::RegionHandle DtDDMRegion::regionHandle ( )

virtual

Access to the RTI region representation.

virtual const RTI::RegionHandle DtDDMRegion::regionHandle ( ) const

virtual

Access to the RTI region representation.

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

virtual

This method sets the lower and upper bounds of the dimension, specified by dimensionName, to the normalized value specified by bounds.

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