dtHLAGM::DDMMultiEnumeratedCalculator Class Reference

#include <ddmmultienumeratedcalculator.h>

Inheritance diagram for dtHLAGM::DDMMultiEnumeratedCalculator:

List of all members.

Public Types
typedef dtHLAGM::DDMAppSpaceCalculator	BaseClass
Public Member Functions
	DDMMultiEnumeratedCalculator ()
virtual	~DDMMultiEnumeratedCalculator ()
virtual dtCore::RefPtr < DDMRegionData >	CreateRegionData () const
	Creates and returns a pointer to a region data object for this calculator.
virtual void	CreateSubscriptionRegionData (std::vector< dtCore::RefPtr< DDMRegionData > > &toFill) const
	Creates and returns a pointer to a region data object for this calculator.
virtual bool	UpdateRegionData (DDMRegionData &ddmData) const
	Updates the subscription region.
long	GetSecondDimensionMinimum () const
	Returns: the minimum second enumerated value. It defaults to 0
void	SetSecondDimensionMinimum (long newMin)
long	GetSecondDimensionMaximum () const
	Returns: the maximum second enumerated value. It defaults to 1
void	SetSecondDimensionMaximum (long newMax)
long	GetSecondDimensionValue () const
	Returns: value to encode in the second enumerated space to encode. It defaults to 0.
void	SetSecondDimensionValue (long newValue)
bool	IsSecondDimensionEnabled () const
	Returns: value to encode in the second enumerated space to encode. It defaults to 0.
void	SetSecondDimensionEnabled (bool newEnabled)
long	GetThirdDimensionMinimum () const
	Returns: the minimum third enumerated value. It defaults to 0
void	SetThirdDimensionMinimum (long newMin)
long	GetThirdDimensionMaximum () const
	Returns: the maximum third enumerated value. It defaults to 1
void	SetThirdDimensionMaximum (long newMax)
long	GetThirdDimensionValue () const
	Returns: value to encode in the third enumerated space to encode. It defaults to 0.
void	SetThirdDimensionValue (long newValue)
bool	IsThirdDimensionEnabled () const
	Returns: value to encode in the third enumerated space to encode. It defaults to 0.
void	SetThirdDimensionEnabled (bool newEnabled)
Static Public Attributes
static const std::string	PROP_SECOND_DIMENSION_MIN
static const std::string	PROP_SECOND_DIMENSION_MAX
static const std::string	PROP_SECOND_DIMENSION_VALUE
static const std::string	PROP_SECOND_DIMENSION_ENABLED
static const std::string	PROP_THIRD_DIMENSION_MIN
static const std::string	PROP_THIRD_DIMENSION_MAX
static const std::string	PROP_THIRD_DIMENSION_VALUE
static const std::string	PROP_THIRD_DIMENSION_ENABLED

---

Member Typedef Documentation

typedef dtHLAGM::DDMAppSpaceCalculator dtHLAGM::DDMMultiEnumeratedCalculator::BaseClass

---

Constructor & Destructor Documentation

dtHLAGM::DDMMultiEnumeratedCalculator::DDMMultiEnumeratedCalculator

(

)

dtHLAGM::DDMMultiEnumeratedCalculator::~DDMMultiEnumeratedCalculator

(

)

[virtual]

---

Member Function Documentation

dtCore::RefPtr< DDMRegionData > dtHLAGM::DDMMultiEnumeratedCalculator::CreateRegionData

(

)

const [virtual]

Creates and returns a pointer to a region data object for this calculator.

This is basically a factory method. This will be called on the calculator when it is creating regions for published entities.

Returns:

the new region data object.

Implements dtHLAGM::DDMRegionCalculator.

void dtHLAGM::DDMMultiEnumeratedCalculator::CreateSubscriptionRegionData

(

std::vector< dtCore::RefPtr< DDMRegionData > > &

toFill

)

const [virtual]

Creates and returns a pointer to a region data object for this calculator.

This is basically a factory method. This will be called on the calculator when it is creating regions for subscription. The calculator may handle multiple regions, so it will fill a vector.

Implements dtHLAGM::DDMRegionCalculator.

bool dtHLAGM::DDMMultiEnumeratedCalculator::UpdateRegionData

(

DDMRegionData &

ddmData

)

const [virtual]

Updates the subscription region.

Parameters:

region

the region to update.

Implements dtHLAGM::DDMRegionCalculator.

long dtHLAGM::DDMMultiEnumeratedCalculator::GetSecondDimensionMinimum

(

)

const [inline]

Returns:

the minimum second enumerated value. It defaults to 0

void dtHLAGM::DDMMultiEnumeratedCalculator::SetSecondDimensionMinimum

(

long

newMin

)

[inline]

long dtHLAGM::DDMMultiEnumeratedCalculator::GetSecondDimensionMaximum

(

)

const [inline]

Returns:

the maximum second enumerated value. It defaults to 1

void dtHLAGM::DDMMultiEnumeratedCalculator::SetSecondDimensionMaximum

(

long

newMax

)

[inline]

long dtHLAGM::DDMMultiEnumeratedCalculator::GetSecondDimensionValue

(

)

const [inline]

Returns:

value to encode in the second enumerated space to encode. It defaults to 0.

void dtHLAGM::DDMMultiEnumeratedCalculator::SetSecondDimensionValue

(

long

newValue

)

[inline]

bool dtHLAGM::DDMMultiEnumeratedCalculator::IsSecondDimensionEnabled

(

)

const [inline]

Returns:

value to encode in the second enumerated space to encode. It defaults to 0.

void dtHLAGM::DDMMultiEnumeratedCalculator::SetSecondDimensionEnabled

(

bool

newEnabled

)

[inline]

long dtHLAGM::DDMMultiEnumeratedCalculator::GetThirdDimensionMinimum

(

)

const [inline]

Returns:

the minimum third enumerated value. It defaults to 0

void dtHLAGM::DDMMultiEnumeratedCalculator::SetThirdDimensionMinimum

(

long

newMin

)

[inline]

long dtHLAGM::DDMMultiEnumeratedCalculator::GetThirdDimensionMaximum

(

)

const [inline]

Returns:

the maximum third enumerated value. It defaults to 1

void dtHLAGM::DDMMultiEnumeratedCalculator::SetThirdDimensionMaximum

(

long

newMax

)

[inline]

long dtHLAGM::DDMMultiEnumeratedCalculator::GetThirdDimensionValue

(

)

const [inline]

Returns:

value to encode in the third enumerated space to encode. It defaults to 0.

void dtHLAGM::DDMMultiEnumeratedCalculator::SetThirdDimensionValue

(

long

newValue

)

[inline]

bool dtHLAGM::DDMMultiEnumeratedCalculator::IsThirdDimensionEnabled

(

)

const [inline]

Returns:

value to encode in the third enumerated space to encode. It defaults to 0.

void dtHLAGM::DDMMultiEnumeratedCalculator::SetThirdDimensionEnabled

(

bool

newEnabled

)

[inline]

---

Member Data Documentation

const std::string dtHLAGM::DDMMultiEnumeratedCalculator::PROP_SECOND_DIMENSION_MIN [static]

const std::string dtHLAGM::DDMMultiEnumeratedCalculator::PROP_SECOND_DIMENSION_MAX [static]

const std::string dtHLAGM::DDMMultiEnumeratedCalculator::PROP_SECOND_DIMENSION_VALUE [static]

const std::string dtHLAGM::DDMMultiEnumeratedCalculator::PROP_SECOND_DIMENSION_ENABLED [static]

const std::string dtHLAGM::DDMMultiEnumeratedCalculator::PROP_THIRD_DIMENSION_MIN [static]

const std::string dtHLAGM::DDMMultiEnumeratedCalculator::PROP_THIRD_DIMENSION_MAX [static]

const std::string dtHLAGM::DDMMultiEnumeratedCalculator::PROP_THIRD_DIMENSION_VALUE [static]

const std::string dtHLAGM::DDMMultiEnumeratedCalculator::PROP_THIRD_DIMENSION_ENABLED [static]

---