class MStringArray

Jump to documentation

public members:

	MStringArray ()
	MStringArray ( const MStringArray & other )
	MStringArray ( const MString strings[], unsigned int count )
	MStringArray ( const char* strings[], unsigned int count )
	MStringArray ( unsigned int initialSize, const MString &initialValue )
	~MStringArray ()
MString	operator[] ( unsigned int index ) const
MStringArray &	operator= ( const MStringArray & other )
MStatus	set ( const MString & element, unsigned int index )
MStatus	set ( char* element, unsigned int index )
MStatus	setLength ( unsigned int length )
unsigned int	length () const
MStatus	remove ( unsigned int index )
MStatus	insert ( const MString & element, unsigned int index )
MStatus	append ( const MString & element )
MStatus	clear ()
MStatus	get ( MString array[] ) const
MStatus	get ( char* array[] ) const
void	setSizeIncrement ( unsigned int newIncrement )
unsigned int	sizeIncrement () const
MString &	operator[] ( unsigned int index ) NO SCRIPT SUPPORT
friend std::ostream &	operator<< (std::ostream &os, const MStringArray &array) NO SCRIPT SUPPORT

Documentation

Description

This class implements an array of MStrings. Common convenience functions are available, and the implementation is compatible with the internal Maya implementation so that it can be passed efficiently between plugins and internal maya data structures.

Functions

MStringArray:: MStringArray ()

Description

Default constructor. The instance is set to contain no elements.

MStringArray:: MStringArray ( const MStringArray & other )

Description

Copy constructor.

Arguments

• other the array with which to initialize this instance

MStringArray:: MStringArray ( const MString src[], unsigned int count )

Description

Create a new array of MStrings and initialize it with the given elements.

Arguments

• src an array of MStrings
• count the number of elements in the src array

MStringArray:: MStringArray ( const char* src[], unsigned int count )

Description

Create a new array of MStrings and initialize it with the given elements. The MStringArray object then owns the character strings and it is responsible for freeing them. The user is responsible for freeing the original array of pointers to type char.

Arguments

• src a C++ array of character pointers
• count the number of elements in the array

MStringArray:: MStringArray ( unsigned int initialSize, const MString &initialValue )

Description

Create a new array of strings of a specified size and initialize all the elements with the given initial value.

Arguments

• initialSize the initial size of the array
• initialValue the initial value of each element

MStringArray:: ~MStringArray ()

Description

The class destructor.

MString MStringArray:: operator[] ( unsigned int index ) const

Description

Index operator. Returns the value of the element at the given index. If the index is out of the range 0 - length()-1, returns a NULL string.

Arguments

• index the index of the element whose value is to be returned

Return Value

• the value of the indicated element.

MString & MStringArray:: operator[] ( unsigned int index )

Description

Index operator allowing assignment to an element of the array. Returns a reference to the element at the given index. If the index is outside the range 0 - length()-1, returns a NULL string.

Arguments

• index the index of the desired element

Return Value

• a reference to the indicated element

MStringArray & MStringArray:: operator= ( const MStringArray & other )

Description

Assignment operator copies all of the elements of the other array into this one.

If the other array was returned as a reference to internal data (eg MFnStringArrayData::array), then this array will also become a reference rather than doing a full copy.

Arguments

• other the array being copied

Return Value

• a reference to this array

MStatus MStringArray:: setLength ( unsigned int length )

Description

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).

Arguments

• size the new size of the array

unsigned int MStringArray:: length () const

Description

Returns the number of elements in the instance.

Return Value

• the number of elements in the instance

MStatus MStringArray:: remove ( unsigned int index )

Description

Remove the array element at the given index. All array elements following the removed element are shifted toward the first element.

Arguments

• index index of the element to be removed

Return Value

• MS::kSuccess operation succeeded
• MS::kInvalidParameter index out of range
• MS::kFailure operation failed

MStatus MStringArray:: insert ( const MString & element, unsigned int index )

Description

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. If the array cannot be expanded in size by 1 element, then the insert will fail and the existing array will remain unchanged.

Arguments

• element the new value to insert into the array
• index the index of the element to set to the the new value

Return Value

• MS::kSuccess if the insert was successful and MS::kFailure otherwise

MStatus MStringArray:: set ( const MString & element, unsigned int index )

Description

Sets the value of the indicated element to the indicated value.

Arguments

• element the new value for the indicated element
• index the index of the element that is to be set to the the new value

Return Value

• MS::kSuccess operation succeeded
• MS::kInvalidParameter index out of range
• MS::kFailure operation failed

MStatus MStringArray:: set ( char* element, unsigned int index )

Description

Sets the value of the indicated element to the indicated char* value.

Arguments

• element the new value for the indicated element
• index the index of the element that is to be set to the the new value

Return Value

• MS::kSuccess operation succeeded
• MS::kInvalidParameter index out of range
• MS::kFailure operation failed

MStatus MStringArray:: append ( const MString & element )

Description

Adds a new element to the end of the array. If the array cannot be expanded in size by 1 element, then the append will fail and the existing array will remain unchanged.

Arguments

• element the value for the new last element

Return Value

• MS::kSuccess if the append was successful and MS::kFailure otherwise

MStatus MStringArray:: clear ()

Description

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.

Return Value

• MS::kSuccess if the operation is successful and MS::kFailure otherwise

MStatus MStringArray:: get ( MString array[] ) const

Description

Copy the elements of the array into the array of MStrings. No checking is done to ensure that the destination array of MStrings is large enough to hold all the elements of the instance.

Arguments

• array the array to populate

Return Value

• MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise

MStatus MStringArray:: get ( char* array[] ) const

Description

Copy the elements of the array into the C++ array of character pointers. No checking is done to ensure that the destination C++ array of character pointers is large enough to hold all the elements of the instance.

Arguments

• array the array to populate

Return Value

• MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise

void MStringArray:: setSizeIncrement ( unsigned int newIncrement )

Description

Set the size by which the array will be expanded whenever expansion is necessary.

Arguments

• newIncrement the new increment

unsigned int MStringArray:: sizeIncrement () const

Description

Return the size by which the array will be expanded whenever expansion is necessary.

Return Value

• true if the array argument is a non-zero pointer and false otherwise

std::ostream& operator<< (std::ostream &os, const MStringArray &array)

Description

Print the contents of the given MStringArray on the given ostream. The format used is ["string", "string", "string", ... "string"].

Arguments

• os the ostream to print to
• array the MStringArray whose value is to be printed

Return Value

• the ostream reference, s, provided as the first parameter.

This class has no child classes.