class MArgParser

Jump to documentation

Inheritance:

MArgParser

public members:

	MArgParser ()
	MArgParser (const MSyntax &syntax, const MArgList &argList, MStatus *ReturnStatus = NULL)
virtual	~MArgParser ()
bool	isFlagSet (const char *flag, MStatus *ReturnStatus = NULL) const
bool	isEdit ( MStatus *ReturnStatus = NULL) const
bool	isQuery ( MStatus *ReturnStatus = NULL) const
unsigned int	numberOfFlagsUsed () const
unsigned int	numberOfFlagUses (const char *flag) const
MStatus	getFlagArgument (const char *flag, unsigned int index, bool &result) const
MStatus	getFlagArgument (const char *flag, unsigned int index, int &result) const
MStatus	getFlagArgument (const char *flag, unsigned int index, double &result) const
MStatus	getFlagArgument (const char *flag, unsigned int index, MString &result) const
MStatus	getFlagArgument (const char *flag, unsigned int index, unsigned int &result) const
MStatus	getFlagArgument (const char *flag, unsigned int index, MDistance &result) const
MStatus	getFlagArgument (const char *flag, unsigned int index, MAngle &result) const
MStatus	getFlagArgument (const char *flag, unsigned int index, MTime &result) const
bool	flagArgumentBool (const char *flag, unsigned int index, MStatus *ReturnStatus = NULL ) const
int	flagArgumentInt (const char *flag, unsigned int index, MStatus *ReturnStatus = NULL ) const
double	flagArgumentDouble (const char *flag, unsigned int index, MStatus *ReturnStatus = NULL) const
MString	flagArgumentString (const char *flag, unsigned int index, MStatus *ReturnStatus = NULL) const
MDistance	flagArgumentMDistance (const char *flag, unsigned int index, MStatus *ReturnStatus = NULL) const
MAngle	flagArgumentMAngle (const char *flag, unsigned int index, MStatus *ReturnStatus = NULL) const
MTime	flagArgumentMTime (const char *flag, unsigned int index, MStatus *ReturnStatus = NULL) const
MStatus	getFlagArgumentPosition (const char *flag, unsigned int i, unsigned int &position) const
MStatus	getFlagArgumentList (const char *flag, unsigned int i, MArgList & args) const
MStatus	getCommandArgument (unsigned int index, bool &result) const
MStatus	getCommandArgument (unsigned int index, int &result) const
MStatus	getCommandArgument (unsigned int index, double &result) const
MStatus	getCommandArgument (unsigned int index, MString &result) const
MStatus	getCommandArgument (unsigned int index, MDistance &result) const
MStatus	getCommandArgument (unsigned int index, MAngle &result) const
MStatus	getCommandArgument (unsigned int index, MTime &result) const
bool	commandArgumentBool (unsigned int index, MStatus *ReturnStatus = NULL ) const
int	commandArgumentInt (unsigned int index, MStatus *ReturnStatus = NULL ) const
double	commandArgumentDouble (unsigned int index, MStatus *ReturnStatus = NULL) const
MString	commandArgumentString (unsigned int index, MStatus *ReturnStatus = NULL) const
MDistance	commandArgumentMDistance (unsigned int index, MStatus *ReturnStatus = NULL) const
MAngle	commandArgumentMAngle (unsigned int index, MStatus *ReturnStatus = NULL) const
MTime	commandArgumentMTime (unsigned int index, MStatus *ReturnStatus = NULL) const
MStatus	getObjects ( MStringArray &result) const

Documentation

Description

This class is used to parse and store all of the flags, arguments and objects which are passed to a command. The MArgParser accepts an MSyntax object, which describes the format for a command, and uses it to parse the command arguments into a form which is easy to query. The documentation for the MSyntax command contains the details on three types of arguments to commands:

• flags arguments preceded by a '-' character.
• command arguments required parameters that follow the flags
• objects an optional list of Maya objects or the contents of the selection list.

Once the syntax for your command has been specified, when the doIt method for the command it called, the provided MArgList instance can be passed to the MArgParser constructor along with the command's syntax object to parse those arguments. If the parsing is unsuccessful, then the provided command was syntactically invalid. If successful, the methods in this class can be used to extract the values of the arguments to the command.

The isFlagSet method can be used to find out if a particular flag argument was provided in the command invocation, and the getFlagArgument methods are used to return the value of that flag.

If the command requires command arguments (i.e. the addArg method was used to construct the syntax object), then getCommandArgument methods are used to return the values of those arguments.

If the command requires objects then the getObjects methods are used to return those objects either as a selection list of as a list of strings.

Note: command arguments and objects are incompatible and must not be combined in the syntax definition of a command. If both have been specified to the Syntax object, then neither the getCommandArgument or getObjects methods will work predictably.

Functions

MArgParser:: MArgParser ()

Description

The default class constructor.

MArgParser:: MArgParser (const MSyntax &syntax, const MArgList &argList, MStatus *ReturnStatus)

Description

Creates an MArgParser object by using the data in 'syntax' to parse the argList.

Arguments

• syntax the syntax object
• argList the argument list
• ReturnStatus the status codes

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MArgParser:: ~MArgParser ()

Description

The class destructor.

bool MArgParser:: isFlagSet (const char *flag, MStatus *ReturnStatus) const

Description

Queries the arguments to the command to determine if the given flag is set.

Arguments

• flag the flag whose state is to be queried
• ReturnStatus the return status

Return Value

• true if given flag is set
• false if given flag is not set

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

bool MArgParser:: isEdit ( MStatus *ReturnStatus) const

Description

Determines if the edit flag was one of the arguments to the command. The edit flag in its short form is "-e", and in its int form is "-edit".

Arguments

• ReturnStatus the return status

Return Value

• true if edit flag is set
• false if edit flag is not set

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

bool MArgParser:: isQuery ( MStatus *ReturnStatus) const

Description

Determines if the query flag was one of the arguments to the command. The query flag in its short form is "-q", and in its int form is "-query".

Arguments

• ReturnStatus the return status

Return Value

• true if query flag is set
• false if query flag is not set

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

unsigned int MArgParser:: numberOfFlagsUsed () const

Description

Returns the number of flags given on the command line command line.

Return Value

• number of flags on the command line

unsigned int MArgParser:: numberOfFlagUses (const char *flag) const

Description

Returns the number of times the given flag was used on the command line.

Arguments

• flag the flag whose argument is being requested

Return Value

• number of times the given flag was used on the command line

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

Description

Gets the value of the requested flag argument to the given flag as a boolean.

Python Notes

This method is not available in Python. Please see the flagArgumentBool() method

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag
• result the value of the argument as a boolean

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

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

Description

Gets the value of the requested flag argument to the given flag as a int.

Python Notes

This method is not available in Python. Please see the flagArgumentInt() method

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag
• result the value of the argument as a int

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

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

Description

Gets the value of the requested flag argument to the given flag as a double.

Python Notes

This method is not available in Python. Please see the flagArgumentDouble() method

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag
• result the value of the argument as a double

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

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

Description

Gets the value of the requested flag argument to the given flag as an MString.

Python Notes

This method is not available in Python. Please see the flagArgumentString() method

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag
• result the value of the argument as an MString

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

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

Description

Gets the value of the requested flag argument to the given flag as an unsigned int.

Python Notes

This method is not available in Python. Please see the flagArgumentInt() method

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag
• result the value of the argument as an unsigned int

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

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

Description

Gets the value of the requested flag argument to the given flag as an MDistance.

Python Notes

This method is not available in Python. Please see the flagArgumentMDistance() method

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag
• result the value of the argument as an MDistance

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

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

Description

Gets the value of the requested flag argument to the given flag as an MAngle.

Python Notes

This method is not available in Python. Please see the flagArgumentMAngle() method

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag
• result the value of the argument as an MAngle

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

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

Description

Gets the value of the requested flag argument to the given flag as an MTime.

Python Notes

This method is not available in Python. Please see the flagArgumentMTime() method

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag
• result the value of the argument as an MTime

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

bool MArgParser:: flagArgumentBool (const char *flag, unsigned int index, MStatus * ReturnStatus) const

Description

Gets the value of the requested flag argument to the given flag as a boolean.

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag

Return Value

• the value of the argument as a boolean

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

int MArgParser:: flagArgumentInt (const char *flag, unsigned int index, MStatus * ReturnStatus) const

Description

Gets the value of the requested flag argument to the given flag as a int.

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag

Return Value

• the value of the argument as an int

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

double MArgParser:: flagArgumentDouble (const char *flag, unsigned int index, MStatus * ReturnStatus) const

Description

Gets the value of the requested flag argument to the given flag as a double.

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag

Return Value

• the value of the argument as a double

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MString MArgParser:: flagArgumentString (const char *flag, unsigned int index, MStatus * ReturnStatus) const

Description

Gets the value of the requested flag argument to the given flag as an MString.

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag

Return Value

• the value of the argument as a string

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MDistance MArgParser:: flagArgumentMDistance (const char *flag, unsigned int index, MStatus * ReturnStatus) const

Description

Gets the value of the requested flag argument to the given flag as an MDistance.

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag

Return Value

• the value of the argument as an MDistance

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MAngle MArgParser:: flagArgumentMAngle (const char *flag, unsigned int index, MStatus * ReturnStatus) const

Description

Gets the value of the requested flag argument to the given flag as an MAngle.

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag

Return Value

• the value of the argument as an MAngle

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MTime MArgParser:: flagArgumentMTime (const char *flag, unsigned int index, MStatus * ReturnStatus) const

Description

Gets the value of the requested flag argument to the given flag as an MTime.

Arguments

• flag the flag whose argument is being requested
• index the index of the argument to the flag

Return Value

• the value of the argument as an MTime

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MArgParser:: getFlagArgumentPosition (const char *flag, unsigned int i, unsigned int &position) const

Description

Returns the position in the command line of the i'th usage of a specified flag. This call is only valid if the flags has been marked as available for multi-usage with MSyntax::makeFlagMultiUse

Arguments

• flag the flag whose argument is being requested
• i the desired instance of the flag on the command line
• position on return the position in the command line of the i'th usage of the specified flag

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MArgParser:: getFlagArgumentList (const char *flag, unsigned int i, MArgList &args) const

Description

Returns an MArgList containing the arguments to the i'th usage of the specified flag. This call is only valid if the flags has been marked as available for multi-usage with MSyntax::makeFlagMultiUse

Arguments

• flag the flag whose argument is being requested
• i the desired instance of the flag on the command line
• args on return the arguments to the i'th usage of the specified flag

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

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

Description

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

Python Notes

This method is not available in Python. Please see the commandArgumentBool() method

Arguments

• index the index of the argument of the command
• result the value of the argument as a boolean

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

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

Description

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

Python Notes

This method is not available in Python. Please see the commandArgumentBool() method

Arguments

• index the index of the argument of the command
• result the value of the argument as a int

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

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

Description

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

Python Notes

This method is not available in Python. Please see the commandArgumentBool() method

Arguments

• index the index of the argument of the command
• result the value of the argument as a double

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MArgParser:: getCommandArgument (unsigned int index, MString &result) const

Description

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

Python Notes

This method is not available in Python. Please see the commandArgumentBool() method

Arguments

• index the index of the argument of the command
• result the value of the argument as an MString

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MArgParser:: getCommandArgument (unsigned int index, MDistance &result) const

Description

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

Python Notes

This method is not available in Python. Please see the commandArgumentBool() method

Arguments

• index the index of the argument of the command
• result the value of the argument as an MDistance

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MArgParser:: getCommandArgument (unsigned int index, MAngle &result) const

Description

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

Python Notes

This method is not available in Python. Please see the commandArgumentBool() method

Arguments

• index the index of the argument of the command
• result the value of the argument as an MAngle

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MArgParser:: getCommandArgument (unsigned int index, MTime &result) const

Description

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

Python Notes

This method is not available in Python. Please see the commandArgumentBool() method

Arguments

• index the index of the argument of the command
• result the value of the argument as an MTime

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

bool MArgParser:: commandArgumentBool (unsigned int index, MStatus *ReturnStatus ) const

Description

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

Arguments

• index the index of the argument to the command

Return Value

• the value of the argument as a boolean

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

int MArgParser:: commandArgumentInt (unsigned int index, MStatus *ReturnStatus ) const

Description

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

Arguments

• index the index of the argument to the command

Return Value

• the value of the argument as an int

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

double MArgParser:: commandArgumentDouble (unsigned int index, MStatus *ReturnStatus) const

Description

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

Arguments

• index the index of the argument to the command

Return Value

• the value of the argument as a double

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MString MArgParser:: commandArgumentString (unsigned int index, MStatus *ReturnStatus) const

Description

Gets the value of the requested command argument as a string.

Arguments

• index the index of the argument to the command

Return Value

• the value of the argument as a string

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MDistance MArgParser:: commandArgumentMDistance (unsigned int index, MStatus *ReturnStatus) const

Description

Gets the value of the requested command argument as a MDistance.

Arguments

• index the index of the argument to the command

Return Value

• the value of the argument as a MDistance

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MAngle MArgParser:: commandArgumentMAngle (unsigned int index, MStatus *ReturnStatus) const

Description

Gets the value of the requested command argument as a MAngle.

Arguments

• index the index of the argument to the command

Return Value

• the value of the argument as a MAngle

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MTime MArgParser:: commandArgumentMTime (unsigned int index, MStatus *ReturnStatus) const

Description

Gets the value of the requested command argument as a MTime.

Arguments

• index the index of the argument to the command

Return Value

• the value of the argument as a MTime

Status Codes

• MS::kSuccess operation successful
• MS::kFailure operation failed

MStatus MArgParser:: getObjects ( MStringArray &result) const

Description

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

Arguments

• result the list of objects passed to the command as an MStringArray

Return Value

• MS::kSuccess operation successful
• MS::kFailure operation failed

Direct child classes:

- MArgDatabase