Public Types | Public Member Functions | Static Public Member Functions

MCommandResult Class Reference

Search for all occurrences

Detailed Description

Result returned from executing a command.

MCommandResult collects the result returned by MGlobal::executeCommand. It can either be an int or an array of int or a double or an array of double or a string or an array of string. Use resultType to find out its type and use the appropriate getResult method to retrieve the result.

#include <MCommandResult.h>

List of all members.

Public Types

enum  Type {
  kInvalid = 0, kInt, kIntArray, kDouble,
  kDoubleArray, kString, kStringArray, kVector,
  kVectorArray, kMatrix, kMatrixArray
}
 

The types of results that MEL commands can return.

More...

Public Member Functions

 MCommandResult (MStatus *ReturnStatus=NULL)
 Constructor for MCommandResult.
virtual ~MCommandResult ()
 Destructor for MCommandResult.
Type resultType (MStatus *ReturnStatus=NULL) const
 Returns the type of the result.
MStatus getResult (int &result) const
 Retrieves the command result which is an int.
MStatus getResult (MIntArray &result) const
 Retrieves the command result which is an int array.
MStatus getResult (double &result) const
 Retrieves the command result which is a double.
MStatus getResult (MDoubleArray &result) const
 Retrieves the command result which is a double array.
MString stringResult (MStatus *ReturnResult=NULL) const
 Retrieves the command result which is a string.
MStatus getResult (MString &result) const
 NO SCRIPT SUPPORT.
MStatus getResult (MStringArray &result) const
 Retrieves the command result which is a string array.
MStatus getResult (MVector &result) const
 Retrieves the command result which is a vector.
MStatus getResult (MVectorArray &result) const
 Retrieves the command result which is a vector array.
MStatus getResult (MDoubleArray &result, int &numRows, int &numColumns) const
 Retrieves the command result which is a matrix.

Static Public Member Functions

static const char * className ()
 Returns the name of this class.

Member Enumeration Documentation

enum Type

The types of results that MEL commands can return.

Enumerator:
kInvalid 

 

kInt 

 

kIntArray 

 

kDouble 

 

kDoubleArray 

 

kString 

 

kStringArray 

 

kVector 

 

kVectorArray 

 

kMatrix 

 

kMatrixArray 

 


Constructor & Destructor Documentation

MCommandResult ( MStatus ReturnStatus = NULL)

Constructor for MCommandResult.

Parameters:
[out]ReturnStatusStatus code

Member Function Documentation

MCommandResult::Type resultType ( MStatus ReturnStatus = NULL) const
MStatus getResult ( int &  result) const

Retrieves the command result which is an int.

Parameters:
[out]resultStorage for the command result
Returns:
Status Code
Status Codes:
MStatus getResult ( MIntArray result) const

Retrieves the command result which is an int array.

Parameters:
[out]resultStorage for the command result
Returns:
Status Code
Status Codes:
MStatus getResult ( double &  result) const

Retrieves the command result which is a double.

Parameters:
[out]resultStorage for the command result
Returns:
Status Code
Status Codes:
MStatus getResult ( MDoubleArray result) const

Retrieves the command result which is a double array.

Parameters:
[out]resultStorage for the command result
Returns:
Status Code
Status Codes:
MString stringResult ( MStatus ReturnStatus = NULL) const

Retrieves the command result which is a string.

Parameters:
[out]ReturnStatusOptional status code. See below.
Returns:
The command result
Status Codes:
MStatus getResult ( MString result) const

NO SCRIPT SUPPORT.

Retrieves the command result which is a string.

Python Notes

This method is not supported in Python. See the stringResult function which returns a string.

Parameters:
[out]resultStorage for the command result
Returns:
Status Code
Status Codes:
MStatus getResult ( MStringArray result) const

Retrieves the command result which is a string array.

Parameters:
[out]resultStorage for the command result
Returns:
Status Code
Status Codes:
MStatus getResult ( MVector result) const

Retrieves the command result which is a vector.

Parameters:
[out]resultStorage for the command result
Returns:
Status Code
Status Codes:
MStatus getResult ( MVectorArray result) const

Retrieves the command result which is a vector array.

Parameters:
[out]resultStorage for the command result
Returns:
Status Code
Status Codes:
MStatus getResult ( MDoubleArray result,
int &  numRows,
int &  numColumns 
) const

Retrieves the command result which is a matrix.

Parameters:
[out]resultStorage for the content of the matrix (row-based)
[out]numRowsThe number of rows in the matrix
[out]numColumnsThe number of columns in the matrix
Returns:
Status Code
Status Codes:
const char * className ( ) [static]

Returns the name of this class.

Returns:
Name of this class.

MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult
MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult MCommandResult