IDataDimension Class Reference

The formal interface description for a DataDimension. More...

Inherited by MXADataDimension.

Inheritance diagram for IDataDimension:

Inheritance graph
[legend]
List of all members.

Public Types

typedef std::vector< Pointer > Container
typedef int32 size_type

Public Member Functions

 IDataDimension ()
virtual ~IDataDimension ()
 MXA_SHARED_POINTERS (IDataDimension)
virtual void setIndex (int32 aValue)=0
 Setter for property Index.
virtual int32 getIndex ()=0
 Getter for property Index.
virtual void setCount (int32 aValue)=0
 Setter for property Count.
virtual int32 getCount ()=0
 Getter for property Count.
virtual void setStartValue (int32 aValue)=0
 Setter for property startValue.
virtual int32 getStartValue ()=0
 Getter for property startValue.
virtual void setIncrement (int32 aValue)=0
 Setter for property increment.
virtual int32 getIncrement ()=0
 Getter for property increment.
virtual void setEndValue (int32 aValue)=0
 Setter for property endValue.
virtual int32 getEndValue ()=0
 Getter for property endValue.
virtual void setDimensionName (std::string aValue)=0
 Setter for property name.
virtual std::string getDimensionName ()=0
 Getter for property name.
virtual void setAltName (std::string aValue)=0
 Setter for property altName.
virtual std::string getAltName ()=0
 Getter for property altName.
virtual void setUniform (int32 aValue)=0
 Setter for property uniform.
virtual int32 getUniform ()=0
 Getter for property uniform.
virtual int32 writeDimension (IDataDimensionWriter *writer)=0
 This method uses the given IDataDimensionWriter to serialize itself to the underlying data storage system.
virtual IDataDimension::size_type maxStartValue ()=0
 Returns the maximum value that the Start Value can have.
virtual IDataDimension::size_type maxEndValue ()=0
 Returns the maximum value that the End Value can have.
virtual IDataDimension::size_type maxIncrement ()=0
 Returns the Maximun Increment value.
virtual IDataDimension::size_type maxCount ()=0
 returns the maximum value that the Count can be
virtual bool isPropertyInitialized (int32 value)=0
 Returns is a property, like count, increment.. is equal to either the maximum or minimum value for its type, indicating that the value is uninitialized.
virtual bool isValid (std::string &message)=0
 Checks some basic properties of the model to make sure they are set correctly.
virtual int32 calculateCount ()=0
 This will force the count value to be calculated based on the current start, end and increment values.

Private Member Functions

 IDataDimension (const IDataDimension &)
void operator= (const IDataDimension &)

Detailed Description

The formal interface description for a DataDimension.

Author:
Mike Jackson
Date:
March 2007
Version:
Revision
1.2


Member Typedef Documentation

typedef std::vector<Pointer> IDataDimension::Container

Reimplemented in MXADataDimension.

typedef int32 IDataDimension::size_type


Constructor & Destructor Documentation

IDataDimension::IDataDimension (  )  [inline]

virtual IDataDimension::~IDataDimension (  )  [inline, virtual]

IDataDimension::IDataDimension ( const IDataDimension  )  [private]


Member Function Documentation

IDataDimension::MXA_SHARED_POINTERS ( IDataDimension   ) 

virtual void IDataDimension::setIndex ( int32  aValue  )  [pure virtual]

Setter for property Index.

Parameters:
aValue The new value to set for property Index

Implemented in MXADataDimension.

virtual int32 IDataDimension::getIndex (  )  [pure virtual]

Getter for property Index.

Returns:
The value of Index

Implemented in MXADataDimension.

virtual void IDataDimension::setCount ( int32  aValue  )  [pure virtual]

Setter for property Count.

Parameters:
aValue The new value to set for property Count

Implemented in MXADataDimension.

virtual int32 IDataDimension::getCount (  )  [pure virtual]

Getter for property Count.

Returns:
The value of Count

Implemented in MXADataDimension.

virtual void IDataDimension::setStartValue ( int32  aValue  )  [pure virtual]

Setter for property startValue.

Parameters:
aValue The new value to set for property startValue

Implemented in MXADataDimension.

virtual int32 IDataDimension::getStartValue (  )  [pure virtual]

Getter for property startValue.

Returns:
The value of startValue

Implemented in MXADataDimension.

virtual void IDataDimension::setIncrement ( int32  aValue  )  [pure virtual]

Setter for property increment.

Parameters:
aValue The new value to set for property increment

Implemented in MXADataDimension.

virtual int32 IDataDimension::getIncrement (  )  [pure virtual]

Getter for property increment.

Returns:
The value of increment

Implemented in MXADataDimension.

virtual void IDataDimension::setEndValue ( int32  aValue  )  [pure virtual]

Setter for property endValue.

Parameters:
aValue The new value to set for property endValue

Implemented in MXADataDimension.

virtual int32 IDataDimension::getEndValue (  )  [pure virtual]

Getter for property endValue.

Returns:
The value of endValue

Implemented in MXADataDimension.

virtual void IDataDimension::setDimensionName ( std::string  aValue  )  [pure virtual]

Setter for property name.

Parameters:
aValue The new value to set for property name

Implemented in MXADataDimension.

virtual std::string IDataDimension::getDimensionName (  )  [pure virtual]

Getter for property name.

Returns:
The value of name

Implemented in MXADataDimension.

virtual void IDataDimension::setAltName ( std::string  aValue  )  [pure virtual]

Setter for property altName.

Parameters:
aValue The new value to set for property altName

Implemented in MXADataDimension.

virtual std::string IDataDimension::getAltName (  )  [pure virtual]

Getter for property altName.

Returns:
The value of altName

Implemented in MXADataDimension.

virtual void IDataDimension::setUniform ( int32  aValue  )  [pure virtual]

Setter for property uniform.

Parameters:
aValue The new value to set for property uniform

Implemented in MXADataDimension.

virtual int32 IDataDimension::getUniform (  )  [pure virtual]

Getter for property uniform.

Returns:
The value of uniform

Implemented in MXADataDimension.

virtual int32 IDataDimension::writeDimension ( IDataDimensionWriter writer  )  [pure virtual]

This method uses the given IDataDimensionWriter to serialize itself to the underlying data storage system.

Parameters:
writer Valid (Non Null) IDataDimensioWriter object
Returns:
Error condition.

Implemented in MXADataDimension.

virtual IDataDimension::size_type IDataDimension::maxStartValue (  )  [pure virtual]

Returns the maximum value that the Start Value can have.

Implemented in MXADataDimension.

virtual IDataDimension::size_type IDataDimension::maxEndValue (  )  [pure virtual]

Returns the maximum value that the End Value can have.

Implemented in MXADataDimension.

virtual IDataDimension::size_type IDataDimension::maxIncrement (  )  [pure virtual]

Returns the Maximun Increment value.

Implemented in MXADataDimension.

virtual IDataDimension::size_type IDataDimension::maxCount (  )  [pure virtual]

returns the maximum value that the Count can be

Implemented in MXADataDimension.

virtual bool IDataDimension::isPropertyInitialized ( int32  value  )  [pure virtual]

Returns is a property, like count, increment.. is equal to either the maximum or minimum value for its type, indicating that the value is uninitialized.

Implemented in MXADataDimension.

virtual bool IDataDimension::isValid ( std::string &  message  )  [pure virtual]

Checks some basic properties of the model to make sure they are set correctly.

Parameters:
message String to hold messages concerning errors/omissions from the model
Returns:
True if the model passes the basic checks

Implemented in MXADataDimension.

virtual int32 IDataDimension::calculateCount (  )  [pure virtual]

This will force the count value to be calculated based on the current start, end and increment values.

Implemented in MXADataDimension.

void IDataDimension::operator= ( const IDataDimension  )  [private]


The documentation for this class was generated from the following file:
Generated on Tue Nov 17 18:43:13 2009 for MXADataModel by  doxygen 1.5.2