DtDDMConveyedRegion Class Reference

The DtDDMConveyedRegion class provides a wrapper around a RTI conveyed region. More...

Collaboration diagram for DtDDMConveyedRegion:

Public Member Functions
	DtDDMConveyedRegion (DtExerciseConn *exConn, RTI::RegionHandle regionHandle)
	Construct usuing the region handle of the conveyed region.
virtual	~DtDDMConveyedRegion ()
	Destructor.
virtual RTI::RegionHandle	regionHandle () const
	Return the RTI region handle.
virtual const RTI::DimensionHandleSet	dimensionHandles () const
	Return the set of dimension handles.
virtual const std::set < DtString > &	dimensionNames () const
	Return the set of dimension names.
virtual RTI::DimensionHandle	dimensionHandle (const DtString &dimName) const
	Get dimension handle from name.
virtual bool	getDimensionName (RTI::DimensionHandle dimHandle, DtString &dimName) const
	Get dimension name from handle Return boo: retrieved named successfully?
virtual bool	getRangeBounds (RTI::DimensionHandle dimHandle, RTI::RangeBounds &rangeBounds) const
	Get the range bounds for the dimension specified by the given handle Return bool: found dimension in region.
virtual bool	getRangeBounds (const DtString &dimName, RTI::RangeBounds &rangeBounds) const
	Get the range bounds for the dimension specified by the given name Return bool: found dimension in region.

Protected Member Functions
	DtDDMConveyedRegion (const DtDDMConveyedRegion &orig)
	Copy constructor. Not implemented. Access only valid during callback.
DtDDMConveyedRegion &	operator= (const DtDDMConveyedRegion &orig)
	Assignment operator. Not implemented. Access only valid during callback.

Protected Attributes
RTI::RegionHandle	myRegionHandle
std::set< DtString >	myDimensionNames
DtExerciseConn *	myExConn
DtVrlRtiAmbassador *	myRtiAmb

Detailed Description

The DtDDMConveyedRegion class provides a wrapper around a RTI conveyed region.

Constructor & Destructor Documentation

DtDDMConveyedRegion::DtDDMConveyedRegion	(	DtExerciseConn *	exConn,
		RTI::RegionHandle	regionHandle
	)

Construct usuing the region handle of the conveyed region.

Exercise connection provided to support interaction with RTI

virtual DtDDMConveyedRegion::~DtDDMConveyedRegion ( )

virtual

Destructor.

DtDDMConveyedRegion::DtDDMConveyedRegion ( const DtDDMConveyedRegion &  orig )

protected

Copy constructor. Not implemented. Access only valid during callback.

Member Function Documentation

virtual RTI::DimensionHandle DtDDMConveyedRegion::dimensionHandle ( const DtString &  dimName ) const

virtual

Get dimension handle from name.

virtual const RTI::DimensionHandleSet DtDDMConveyedRegion::dimensionHandles ( ) const

virtual

Return the set of dimension handles.

virtual const std::set<DtString>& DtDDMConveyedRegion::dimensionNames ( ) const

virtual

Return the set of dimension names.

virtual bool DtDDMConveyedRegion::getDimensionName ( RTI::DimensionHandle  dimHandle, DtString &  dimName  ) const

virtual

Get dimension name from handle Return boo: retrieved named successfully?

virtual bool DtDDMConveyedRegion::getRangeBounds ( RTI::DimensionHandle  dimHandle, RTI::RangeBounds &  rangeBounds  ) const

virtual

Get the range bounds for the dimension specified by the given handle Return bool: found dimension in region.

virtual bool DtDDMConveyedRegion::getRangeBounds ( const DtString &  dimName, RTI::RangeBounds &  rangeBounds  ) const

virtual

Get the range bounds for the dimension specified by the given name Return bool: found dimension in region.

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

protected

Assignment operator. Not implemented. Access only valid during callback.

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

virtual

Return the RTI region handle.

Member Data Documentation

std::set<DtString> DtDDMConveyedRegion::myDimensionNames

mutableprotected

DtExerciseConn* DtDDMConveyedRegion::myExConn

protected

RTI::RegionHandle DtDDMConveyedRegion::myRegionHandle

protected

DtVrlRtiAmbassador* DtDDMConveyedRegion::myRtiAmb

protected

---

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

• ddmConveyedRegion1516.h