Inherits IDataDimension.
Inheritance diagram for MXADataDimension:
Public Types | |
typedef std::vector< Pointer > | Container |
Public Member Functions | |
MXA_SHARED_POINTERS (MXADataDimension) | |
virtual | ~MXADataDimension () |
void | setIndex (int32 aValue) |
Setter for property Index. | |
int32 | getIndex () |
Getter for property Index. | |
void | setCount (int32 aValue) |
Setter for property Count. | |
int32 | getCount () |
Getter for property Count. | |
void | setStartValue (int32 aValue) |
Setter for property startValue. | |
int32 | getStartValue () |
Getter for property startValue. | |
void | setIncrement (int32 aValue) |
Setter for property increment. | |
int32 | getIncrement () |
Getter for property increment. | |
void | setEndValue (int32 aValue) |
Setter for property endValue. | |
int32 | getEndValue () |
Getter for property endValue. | |
void | setDimensionName (std::string aValue) |
Setter for property name. | |
std::string | getDimensionName () |
Getter for property name. | |
void | setAltName (std::string aValue) |
Setter for property altName. | |
std::string | getAltName () |
Getter for property altName. | |
void | setUniform (int32 aValue) |
Setter for property uniform. | |
int32 | getUniform () |
Getter for property uniform. | |
int32 | writeDimension (IDataDimensionWriter *writer) |
This method uses the given IDataDimensionWriter to serialize itself to the underlying data storage system. | |
void | setNodeName (std::string nodeName) |
void | printNode (std::ostream &os, int32 indent) |
IDataDimension::size_type | maxStartValue () |
Returns the maximum value that the Start Value can have. | |
IDataDimension::size_type | maxEndValue () |
Returns the maximum value that the End Value can have. | |
IDataDimension::size_type | maxIncrement () |
Returns the Maximun Increment value. | |
IDataDimension::size_type | maxCount () |
returns the maximum value that the Count can be | |
bool | isPropertyInitialized (int32 value) |
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. | |
bool | isValid (std::string &message) |
Checks some basic properties of the model to make sure they are set correctly. | |
int32 | calculateCount () |
This will force the count value to be calculated based on the current start, end and increment values. | |
Static Public Member Functions | |
static MXADataDimension::Pointer | New (std::string name, std::string altName, int32 index=std::numeric_limits< int32 >::min(), int32 count=std::numeric_limits< int32 >::min(), int32 startValue=std::numeric_limits< int32 >::max(), int32 endValue=std::numeric_limits< int32 >::max(), int32 increment=std::numeric_limits< int32 >::max(), int32 uniform=std::numeric_limits< int32 >::min()) |
Used to create a new MXANode. | |
static IDataDimension::Pointer | New (IDataDimension::Pointer dim) |
Performs a Deep copy of passed in MXADataDimension object. | |
Protected Member Functions | |
MXADataDimension () | |
Protected Attributes | |
int32 | _index |
int32 | _count |
int32 | _startValue |
int32 | _endValue |
int32 | _increment |
int32 | _uniform |
std::string | _dimensionName |
std::string | _altName |
std::string | _nodeName |
std::string | _nodeType |
Private Member Functions | |
MXADataDimension (const MXADataDimension &) | |
void | operator= (const MXADataDimension &) |
typedef std::vector<Pointer> MXADataDimension::Container |
Reimplemented from IDataDimension.
MXADataDimension::~MXADataDimension | ( | ) | [virtual] |
MXADataDimension::MXADataDimension | ( | ) | [protected] |
MXADataDimension::MXADataDimension | ( | const MXADataDimension & | ) | [private] |
MXADataDimension::MXA_SHARED_POINTERS | ( | MXADataDimension | ) |
MXADataDimension::Pointer MXADataDimension::New | ( | std::string | name, | |
std::string | altName, | |||
int32 | index = std::numeric_limits< int32 >::min() , |
|||
int32 | count = std::numeric_limits< int32 >::min() , |
|||
int32 | startValue = std::numeric_limits< int32 >::max() , |
|||
int32 | endValue = std::numeric_limits< int32 >::max() , |
|||
int32 | increment = std::numeric_limits< int32 >::max() , |
|||
int32 | uniform = std::numeric_limits< int32 >::min() | |||
) | [static] |
Used to create a new MXANode.
name | The name for the Data Dimensions | |
altName | An Alternate Name for the Data Dimension | |
index | The index of this dimension | |
count | The total number of | |
startValue | The value this dimension starts at | |
endValue | The ending value (inclusive) this dimension ends at | |
increment | The value to increment the dimension when iterating | |
uniform | Are the values uniform across the start to end values |
static IDataDimension::Pointer MXADataDimension::New | ( | IDataDimension::Pointer | dim | ) | [inline, static] |
Performs a Deep copy of passed in MXADataDimension object.
dim | The MXADataDimension object to copy |
void MXADataDimension::setIndex | ( | int32 | aValue | ) | [virtual] |
Setter for property Index.
aValue | The new value to set for property Index |
Implements IDataDimension.
int32 MXADataDimension::getIndex | ( | ) | [virtual] |
void MXADataDimension::setCount | ( | int32 | aValue | ) | [inline, virtual] |
Setter for property Count.
aValue | The new value to set for property Count |
Implements IDataDimension.
int32 MXADataDimension::getCount | ( | ) | [inline, virtual] |
void MXADataDimension::setStartValue | ( | int32 | aValue | ) | [inline, virtual] |
Setter for property startValue.
aValue | The new value to set for property startValue |
Implements IDataDimension.
int32 MXADataDimension::getStartValue | ( | ) | [inline, virtual] |
void MXADataDimension::setIncrement | ( | int32 | aValue | ) | [inline, virtual] |
Setter for property increment.
aValue | The new value to set for property increment |
Implements IDataDimension.
int32 MXADataDimension::getIncrement | ( | ) | [inline, virtual] |
void MXADataDimension::setEndValue | ( | int32 | aValue | ) | [inline, virtual] |
Setter for property endValue.
aValue | The new value to set for property endValue |
Implements IDataDimension.
int32 MXADataDimension::getEndValue | ( | ) | [inline, virtual] |
void MXADataDimension::setDimensionName | ( | std::string | aValue | ) | [inline, virtual] |
Setter for property name.
aValue | The new value to set for property name |
Implements IDataDimension.
std::string MXADataDimension::getDimensionName | ( | ) | [inline, virtual] |
void MXADataDimension::setAltName | ( | std::string | aValue | ) | [inline, virtual] |
Setter for property altName.
aValue | The new value to set for property altName |
Implements IDataDimension.
std::string MXADataDimension::getAltName | ( | ) | [inline, virtual] |
void MXADataDimension::setUniform | ( | int32 | aValue | ) | [inline, virtual] |
Setter for property uniform.
aValue | The new value to set for property uniform |
Implements IDataDimension.
int32 MXADataDimension::getUniform | ( | ) | [inline, virtual] |
int32 MXADataDimension::writeDimension | ( | IDataDimensionWriter * | writer | ) | [virtual] |
This method uses the given IDataDimensionWriter to serialize itself to the underlying data storage system.
writer | Valid (Non Null) IDataDimensioWriter object |
Implements IDataDimension.
void MXADataDimension::setNodeName | ( | std::string | nodeName | ) |
void MXADataDimension::printNode | ( | std::ostream & | os, | |
int32 | indent | |||
) |
IDataDimension::size_type MXADataDimension::maxStartValue | ( | ) | [inline, virtual] |
IDataDimension::size_type MXADataDimension::maxEndValue | ( | ) | [inline, virtual] |
IDataDimension::size_type MXADataDimension::maxIncrement | ( | ) | [inline, virtual] |
IDataDimension::size_type MXADataDimension::maxCount | ( | ) | [inline, virtual] |
bool MXADataDimension::isPropertyInitialized | ( | int32 | value | ) | [inline, 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.
Implements IDataDimension.
bool MXADataDimension::isValid | ( | std::string & | message | ) | [virtual] |
Checks some basic properties of the model to make sure they are set correctly.
message | String to hold messages concerning errors/omissions from the model |
Implements IDataDimension.
int32 MXADataDimension::calculateCount | ( | ) | [virtual] |
This will force the count value to be calculated based on the current start, end and increment values.
Implements IDataDimension.
void MXADataDimension::operator= | ( | const MXADataDimension & | ) | [private] |
int32 MXADataDimension::_index [protected] |
int32 MXADataDimension::_count [protected] |
int32 MXADataDimension::_startValue [protected] |
int32 MXADataDimension::_endValue [protected] |
int32 MXADataDimension::_increment [protected] |
int32 MXADataDimension::_uniform [protected] |
std::string MXADataDimension::_dimensionName [protected] |
std::string MXADataDimension::_altName [protected] |
std::string MXADataDimension::_nodeName [protected] |
std::string MXADataDimension::_nodeType [protected] |