Public Member Functions | Static Public Member Functions

MArgDatabase Class Reference

This reference page is linked to from the following overview topics: Syntax objects, Flags, MPxToolCommand, Using the Maya Python API, Differences Between Maya's C++ and Python APIs, Using .NET assembly attributes.


Search for all occurrences

Detailed Description

Command argument list parser.

This class extends MArgParser by providing the ability to retrieve flag parameters, command arguments and command objects as selection lists.

See MArgParser for more details on how command argument parsing works in general.

Examples:

cgfxShaderCmd.cpp, closestPointOnCurveCmd.cpp, clusterWeightFunction.cpp, conditionTest.cpp, dagMessageCmd.cpp, deletedMsgCmd.cpp, eventTest.cpp, filteredAsciiFile.cpp, flipUVCmd.cpp, flipUVCmd.h, fxManagerCmd.cpp, geometryCacheConverter.cpp, geometrySurfaceConstraint.cpp, helixTool.cpp, lockEvent.cpp, nodeCreatedCBCmd.cpp, nodeInfoCmd.cpp, particlePathsCmd.cpp, peltOverlapCmd.cpp, renderViewInteractiveRenderCmd.cpp, renderViewRenderCmd.cpp, renderViewRenderRegionCmd.cpp, scanDagSyntax.cpp, userMsgCmd.cpp, and viewCallbackTest.cpp.

#include <MArgDatabase.h>

Inheritance diagram for MArgDatabase:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 MArgDatabase ()
 Default Constructor.
 MArgDatabase (const MSyntax &syntax, const MArgList &argList, MStatus *ReturnStatus=NULL)
 Creates an MArgDatabase object by using the data in syntax to parse the arguments provided in argList.
virtual ~MArgDatabase ()
 The class destructor.
MStatus getFlagArgument (const char *flag, unsigned int index, MSelectionList &result) const
 Gets the value of the 'index'th parameter of the given flag as an MSelectionList.
MStatus getCommandArgument (unsigned int index, MSelectionList &result) const
 Gets the value of the requested command argument and appends it to the end of the MSelectionList that is passed in.
MStatus getObjects (MSelectionList &result) const
 Gets the list of objects passed to the command as an MSelectionList.
MStatus getFlagArgument (const char *flag, unsigned int index, bool &result) const
 This method is not available in Python.
MStatus getFlagArgument (const char *flag, unsigned int index, int &result) const
 This method is not available in Python.
MStatus getFlagArgument (const char *flag, unsigned int index, double &result) const
 This method is not available in Python.
MStatus getFlagArgument (const char *flag, unsigned int index, MString &result) const
 This method is not available in Python.
MStatus getFlagArgument (const char *flag, unsigned int index, unsigned int &result) const
 This method is not available in Python.
MStatus getFlagArgument (const char *flag, unsigned int index, MDistance &result) const
 This method is not available in Python.
MStatus getFlagArgument (const char *flag, unsigned int index, MAngle &result) const
 This method is not available in Python.
MStatus getFlagArgument (const char *flag, unsigned int index, MTime &result) const
 This method is not available in Python.
MStatus getCommandArgument (unsigned int index, bool &result) const
 This method is not available in Python.
MStatus getCommandArgument (unsigned int index, int &result) const
 This method is not available in Python.
MStatus getCommandArgument (unsigned int index, double &result) const
 This method is not available in Python.
MStatus getCommandArgument (unsigned int index, MString &result) const
 This method is not available in Python.
MStatus getCommandArgument (unsigned int index, MDistance &result) const
 This method is not available in Python.
MStatus getCommandArgument (unsigned int index, MAngle &result) const
 This method is not available in Python.
MStatus getCommandArgument (unsigned int index, MTime &result) const
 This method is not available in Python.
MStatus getObjects (MStringArray &result) const
 Gets the list of objects passed to the command as an array of strings.

Static Public Member Functions

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

Constructor & Destructor Documentation

MArgDatabase ( const MSyntax syntax,
const MArgList argList,
MStatus ReturnStatus = NULL 
)

Creates an MArgDatabase object by using the data in syntax to parse the arguments provided in argList.

Parameters:
[in]syntaxthe syntax object
[in]argListthe argument list
[out]ReturnStatusreturn status
Status Codes:
  • MS::kSuccess parsing successful. The MArgDatabase instance was constructed sucessfully.
  • MS::kFailure The provided arguments were not syntactically valid as specified by the syntax object, The MArgDatabase instance was not constructed sucessfully.

Member Function Documentation

MStatus getFlagArgument ( const char *  flag,
unsigned int  index,
MSelectionList result 
) const

Gets the value of the 'index'th parameter of the given flag as an MSelectionList.

Parameters:
[in]flagflag whose parameter is being requested
[in]indexindex of the parameter
[out]resultvalue of the parameter as an MSelectionList
Returns:
Examples:
flipUVCmd.cpp, fxManagerCmd.cpp, nodeCreatedCBCmd.cpp, and renderViewInteractiveRenderCmd.cpp.
MStatus getCommandArgument ( unsigned int  index,
MSelectionList result 
) const

Gets the value of the requested command argument and appends it to the end of the MSelectionList that is passed in.

Parameters:
[in]indexindex of the command argument
[out]resultvalue of the argument as an MSelectionList
Returns:
MStatus getObjects ( MSelectionList result) const

Gets the list of objects passed to the command as an MSelectionList.

Parameters:
[out]resultlist of objects passed to the command
Returns:
MStatus getFlagArgument ( const char *  flag,
unsigned int  index,
bool &  result 
) const

This method is not available in Python.

Gets the value of the 'index'th parameter of the given flag as a boolean.

Python Notes

Use flagArgumentBool() instead.

Parameters:
[in]flagflag whose parameter is being requested
[in]indexindex of the parameter to retrieve
[out]resultvalue of the parameter as a boolean
Returns:

Reimplemented from MArgParser.

MStatus getFlagArgument ( const char *  flag,
unsigned int  index,
int &  result 
) const

This method is not available in Python.

Gets the value of the 'index'th parameter of the given flag as an int.

Python Notes

Use flagArgumentInt() instead.

Parameters:
[in]flagflag whose parameter is being requested
[in]indexindex of the parameter to retrieve
[out]resultvalue of the parameter as an int
Returns:

Reimplemented from MArgParser.

MStatus getFlagArgument ( const char *  flag,
unsigned int  index,
double &  result 
) const

This method is not available in Python.

Gets the value of the 'index'th parameter of the given flag as a double.

Python Notes

Use flagArgumentDouble() instead.

Parameters:
[in]flagflag whose parameter is being requested
[in]indexindex of the parameter to retrieve
[out]resultvalue of the parameter as a double
Returns:

Reimplemented from MArgParser.

MStatus getFlagArgument ( const char *  flag,
unsigned int  index,
MString result 
) const

This method is not available in Python.

Gets the value of the 'index'th parameter of the given flag as an MString.

Python Notes

Use flagArgumentString() instead.

Parameters:
[in]flagflag whose parameter is being requested
[in]indexindex of the parameter to retrieve
[out]resultvalue of the parameter as an MString
Returns:

Reimplemented from MArgParser.

MStatus getFlagArgument ( const char *  flag,
unsigned int  index,
unsigned int &  result 
) const

This method is not available in Python.

Gets the value of the 'index'th parameter of the given flag as an unsigned int.

Python Notes

Use flagArgumentInt() instead.

Parameters:
[in]flagflag whose parameter is being requested
[in]indexindex of the parameter to retrieve
[out]resultvalue of the parameter as an unsigned int
Returns:

Reimplemented from MArgParser.

MStatus getFlagArgument ( const char *  flag,
unsigned int  index,
MDistance result 
) const

This method is not available in Python.

Gets the value of the 'index'th parameter of the given flag as an MDistance.

Python Notes

Use flagArgumentMDistance() instead.

Parameters:
[in]flagflag whose parameter is being requested
[in]indexindex of the parameter to retrieve
[out]resultvalue of the parameter as an MDistance
Returns:

Reimplemented from MArgParser.

MStatus getFlagArgument ( const char *  flag,
unsigned int  index,
MAngle result 
) const

This method is not available in Python.

Gets the value of the 'index'th parameter of the given flag as an MAngle.

Python Notes

Use flagArgumentMAngle() instead.

Parameters:
[in]flagflag whose parameter is being requested
[in]indexindex of the parameter to retrieve
[out]resultvalue of the parameter as an MAngle
Returns:

Reimplemented from MArgParser.

MStatus getFlagArgument ( const char *  flag,
unsigned int  index,
MTime result 
) const

This method is not available in Python.

Gets the value of the 'index'th parameter of the given flag as an MTime.

Python Notes

Use flagArgumentMTime() instead.

Parameters:
[in]flagflag whose parameter is being requested
[in]indexindex of the parameter to retrieve
[out]resultvalue of the parameter as an MTime
Returns:

Reimplemented from MArgParser.

MStatus getCommandArgument ( unsigned int  index,
bool &  result 
) const

This method is not available in Python.

Gets the value of the requested command argument to the command as a boolean.

Python Notes

Use commandArgumentBool() instead.

Parameters:
[in]indexthe index of the argument of the command
[out]resultthe value of the argument as a boolean
Returns:

Reimplemented from MArgParser.

MStatus getCommandArgument ( unsigned int  index,
int &  result 
) const

This method is not available in Python.

Gets the value of the requested command argument to the command as an int.

Python Notes

Use commandArgumentInt() instead.

Parameters:
[in]indexthe index of the argument of the command
[out]resultthe value of the argument as a int
Returns:

Reimplemented from MArgParser.

MStatus getCommandArgument ( unsigned int  index,
double &  result 
) const

This method is not available in Python.

Gets the value of the requested command argument to the command as a double.

Python Notes

Use commandArgumentDouble() instead.

Parameters:
[in]indexthe index of the argument of the command
[out]resultthe value of the argument as a double
Returns:

Reimplemented from MArgParser.

MStatus getCommandArgument ( unsigned int  index,
MString result 
) const

This method is not available in Python.

Gets the value of the requested command argument to the command as an MString.

Python Notes

Use commandArgumentString() instead.

Parameters:
[in]indexthe index of the argument of the command
[out]resultthe value of the argument as an MString
Returns:

Reimplemented from MArgParser.

MStatus getCommandArgument ( unsigned int  index,
MDistance result 
) const

This method is not available in Python.

Gets the value of the requested command argument to the command as an MDistance.

Python Notes

Use commandArgumentMDistance() instead.

Parameters:
[in]indexthe index of the argument of the command
[out]resultthe value of the argument as an MDistance
Returns:

Reimplemented from MArgParser.

MStatus getCommandArgument ( unsigned int  index,
MAngle result 
) const

This method is not available in Python.

Gets the value of the requested command argument to the command as an MAngle.

Python Notes

Use commandArgumentMAngle() instead.

Parameters:
[in]indexthe index of the argument of the command
[out]resultthe value of the argument as an MAngle
Returns:

Reimplemented from MArgParser.

MStatus getCommandArgument ( unsigned int  index,
MTime result 
) const

This method is not available in Python.

Gets the value of the requested command argument to the command as an MTime.

Python Notes

Use commandArgumentMTime() instead.

Parameters:
[in]indexthe index of the argument of the command
[out]resultthe value of the argument as an MTime
Returns:

Reimplemented from MArgParser.

MStatus getObjects ( MStringArray result) const

Gets the list of objects passed to the command as an array of strings.

Parameters:
[out]resultthe list of objects passed to the command as an MStringArray
Returns:

Reimplemented from MArgParser.

const char * className ( ) [static]

Returns the name of this class.

Returns:
Name of this class.

Reimplemented from MArgParser.


MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase
MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase MArgDatabase