MStringArray Class Reference
[OpenMaya - API module for common classes]

#include <MStringArray.h>

List of all members.

Detailed Description

Array of MStrings data type.

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.

Examples:

animImportExport.cpp, blindDataMesh.cpp, cgfxAttrDef.cpp, cgfxAttrDef.h, cgfxFindImage.cpp, cgfxFindImage.h, cgfxShaderCmd.cpp, cgfxShaderCmd.h, cgfxShaderNode.cpp, cgfxShaderNode.h, cleanPerFaceAssignmentCmd.cpp, closestPointOnCurveCmd.cpp, conditionTest.cpp, convertEdgesToFacesCmd.cpp, convertVerticesToEdgesCmd.cpp, convertVerticesToFacesCmd.cpp, cvExpandCmd.cpp, D3DResourceManager.cpp, D3DResourceManager.h, D3DViewportRenderer.cpp, ddsFloatReader.cpp, eventTest.cpp, filteredAsciiFile.cpp, GLSLShaderNode.cpp, GLSLShaderNode.h, hlslShader.h, hwColorPerVertexShader.cpp, hwPhongShader.cpp, hwPhongShader.h, hwReflectBumpShader_NV20.cpp, hwRefractReflectShader_NV20.cpp, lepTranslator.cpp, lineManipContainer.cpp, lockEvent.cpp, maTranslator.cpp, meshRemapTool.cpp, meshReorderTool.cpp, narrowPolyViewer.cpp, narrowPolyViewer.h, nodeCreatedCBCmd.cpp, nodeCreatedCBCmd.h, objExport.cpp, OpenEXR.cpp, peltOverlapCmd.cpp, pluginCallbacks.cpp, polyRawWriter.cpp, referenceQueryCmd.cpp, simpleImageFile.cpp, squareScaleManipContext.cpp, tiffFloatReader.cpp, whatisCmd.cpp, and XmlGeometryCache.cpp.


Public Member Functions

 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.

Friends

OPENMAYA_EXPORT std::ostream & operator<< (std::ostream &os, const MStringArray &array)
 NO SCRIPT SUPPORT.

Constructor & Destructor Documentation

MStringArray::MStringArray (  ) 

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

MStringArray::MStringArray ( const MStringArray &  other  ) 

Copy constructor.

Parameters:
[in] other the array with which to initialize this instance

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

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

Parameters:
[in] src an array of MStrings
[in] count the number of elements in the src array

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

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.

Parameters:
[in] src a C++ array of character pointers
[in] count the number of elements in the array

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

Create a new array of strings 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

MStringArray::~MStringArray (  ) 

The class destructor.

Member Function Documentation

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

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.

Parameters:
[in] index the index of the element whose value is to be returned
Returns:
The value of the indicated element.

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

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.

Parameters:
[in] other the array being copied
Returns:
A reference to this array

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

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

Parameters:
[in] element the new value for the indicated element
[in] index the index of the element that is to be set to the the new value
Returns:
Examples:
GLSLShaderNode.cpp.

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

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

Parameters:
[in] element the new value for the indicated element
[in] index the index of the element that is to be set to the the new value
Returns:

MStatus MStringArray::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
Examples:
cgfxShaderNode.cpp.

unsigned int MStringArray::length (  )  const

Returns the number of elements in the instance.

Returns:
The number of elements in the instance
Examples:
animImportExport.cpp, cgfxAttrDef.cpp, cgfxShaderCmd.cpp, cgfxShaderNode.cpp, conditionTest.cpp, D3DResourceManager.cpp, D3DViewportRenderer.cpp, eventTest.cpp, filteredAsciiFile.cpp, GLSLShaderNode.cpp, lepTranslator.cpp, lockEvent.cpp, maTranslator.cpp, meshRemapTool.cpp, meshReorderTool.cpp, nodeCreatedCBCmd.cpp, objExport.cpp, peltOverlapCmd.cpp, pluginCallbacks.cpp, polyRawWriter.cpp, referenceQueryCmd.cpp, whatisCmd.cpp, and XmlGeometryCache.cpp.

MStatus MStringArray::remove ( unsigned int  index  ) 

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

Parameters:
[in] index index of the element to be removed
Returns:
Examples:
cleanPerFaceAssignmentCmd.cpp, eventTest.cpp, and nodeCreatedCBCmd.cpp.

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

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.

Parameters:
[in] element the new value to insert into the array
[in] index the index of the element to set to the the new value
Returns:
MS::kSuccess if the insert was successful and MS::kFailure otherwise

MStatus MStringArray::append ( const MString &  element  ) 

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.

Parameters:
[in] element the value for the new last element
Returns:
MS::kSuccess if the append was successful and MS::kFailure otherwise
Examples:
blindDataMesh.cpp, cgfxAttrDef.cpp, cgfxFindImage.cpp, cgfxShaderCmd.cpp, cgfxShaderNode.cpp, cleanPerFaceAssignmentCmd.cpp, D3DResourceManager.cpp, ddsFloatReader.cpp, GLSLShaderNode.cpp, hwReflectBumpShader_NV20.cpp, hwRefractReflectShader_NV20.cpp, lineManipContainer.cpp, maTranslator.cpp, nodeCreatedCBCmd.cpp, objExport.cpp, OpenEXR.cpp, simpleImageFile.cpp, squareScaleManipContext.cpp, tiffFloatReader.cpp, and XmlGeometryCache.cpp.

MStatus MStringArray::clear (  ) 

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:
MS::kSuccess if the operation is successful and MS::kFailure otherwise
Examples:
animImportExport.cpp, cgfxAttrDef.cpp, cgfxShaderNode.cpp, conditionTest.cpp, eventTest.cpp, lepTranslator.cpp, maTranslator.cpp, nodeCreatedCBCmd.cpp, objExport.cpp, and XmlGeometryCache.cpp.

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

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.

Parameters:
[out] array the array to populate
Returns:
MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise

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

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.

Parameters:
[out] array the array to populate
Returns:
MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise

void MStringArray::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 MStringArray::sizeIncrement (  )  const

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

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

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

NO SCRIPT SUPPORT.

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.

Parameters:
[in] index the index of the desired element
Returns:
A reference to the indicated element

Friends And Related Function Documentation

OPENMAYA_EXPORT std::ostream& operator<< ( std::ostream &  os,
const MStringArray &  array 
) [friend]

NO SCRIPT SUPPORT.

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

Parameters:
[in] os the ostream to print to
[in] array the MStringArray whose value is to be printed
Returns:
The ostream reference, s, provided as the first parameter.

Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6