MAttributeSpecArray Class Reference
#include <MAttributeSpecArray.h>
An attribute specification array.
Array class for MAttributeSpec .
See MAttributeSpec for more information.
Default constructor.
The array is set to contain no elements.
Copy Constructor.
Parameters
[in] other the array with which to initialize this array
Create a new array of MAttributeSpecs of a specified size and initialize all the elements with the given initial value.
Parameters
[in] initialSize the initial size of the array
[in] initialValue the initial value of each element
Index operator.
Returns the value of the element at the given index. Valid indices are 0 to length() -1.
Parameters
[in] index the index of the element to return
Returns A reference to the specified element
Assignment operator.
Parameters
[in] other The source object to assign from.
Returns A reference to the copied MAttributeSpecArray object.
Sets the value of the specified element to the given attribute spec.
Parameters
[in] element the new value for the specified element
[in] index the index of the element to be set
Returns
MStatus setLength
(
unsigned int
length )
Set the length of the array.
This will grow and shrink the array as desired. Elements that are grown have uninitialized values, while those which are shrunk will lose the data contained in the deleted elements (ie. it will release the memory).
Parameters
[in] length the new size of the array
Returns
unsigned int length
(
)
const
Returns the number of elements in the array.
Returns The number of elements in the array
MStatus remove
(
unsigned int
index )
Removes the element in the array at the given index.
Parameters
[in] index the index of the element to removed
Returns
Inserts a new value into the array at the given index.
The initial element at that index, and all following elements, are shifted towards the last.
Parameters
[in] element the new value to insert into the array
[in] index the index of the element to set
Returns
Adds a new element to the end of the array.
Parameters
[in] element the value for the new last element
Returns
Copy the contents of the source array to this array.
Parameters
[in] source array to copy from
Returns MS::kSuccess if the copy was successful and MS::kFailure otherwise
Clear the contents of the array.
After this operation the length method will return 0. This does not change the amount of memory allocated to the array, only the number of valid elements in it.
Returns
void setSizeIncrement
(
unsigned int
newIncrement )
Set the size by which the array will be expanded whenever expansion is necessary.
Parameters
[in] newIncrement the new increment
unsigned int sizeIncrement
(
)
const
Return the size by which the array will be expanded whenever expansion is necessary.
Returns The size increment.
const char * className
(
)
static
Returns the name of this class.
Returns The name of this class.
The documentation for this class was generated from the following files:
MAttributeSpecArray.h
MAttributeSpecArray.cpp