tronverte.maya.core.status.Status Class Reference

Inherited from tronverte.core.status.Status, tronverte.maya.core.status.Code. More...

Inherits tronverte.maya.core.status.Code.

List of all members.

Public Member Functions
def	__init__
def	display
Static Public Member Functions
def	displayInfo
def	displayWarning
def	displayError

---

Detailed Description

Inherited from tronverte.core.status.Status, tronverte.maya.core.status.Code.

import tronverte.maya.core.status as tronverte_maya_core_status
reload(tronverte_maya_core_status)
stat = tronverte_maya_core_status.Status()

This class inherited from tronverte.core.status.Status class and some of its methods overwritten to fit Autodesk Maya related exception handling.

Status class provides functionalities to handle exceptions in our API classes. Although we provide Status class, API users do not have to use it. It's optional but highly suggested.

When a command fails you can get detailed information about it via Status class. When you see "stat" in a method, you can pass an instance of Status class to obtain detailed information.

---

Constructor & Destructor Documentation

def tronverte.maya.core.status.Status.__init__	(		self,
			showInfoMessages = True,
			showWarningMessages = True,
			showErrorMessages = True,
			name = ''
	)

# DESCRIPTION
Default constructor.

# ARGUMENTS
showInfoMessages    | bool | True | in | * | arg | Whether to show info messages when "display" method is called.
showWarningMessages | bool | True | in | * | arg | Whether to show warning messages when "display" method is called.
showErrorMessages   | bool | True | in | * | arg | Whether to show error messages when "display" method is called.
name                | str  | ''   | in | * | arg | Name of the instance.

# RETURN
None

---

Member Function Documentation

def tronverte.maya.core.status.Status.display	(		self,
			displayName = False
	)

# DESCRIPTION
Display messages. This is an overwritten method.

This method uses MGlobal::displayInfo, MGlobal::displayWarning and MGlobal::displayError methods to display the messages.

# ARGUMENTS
displayName | bool | False | in | * | arg | Whether to display name of the instance.

# RETURN
None

def tronverte.maya.core.status.Status.displayError

(

error

)

[static]

# DESCRIPTION
Display info by using maya.OpenMaya.MGlobal.displayError. If maya.OpenMaya.MGlobal is not available print will be used instead.

# ARGUMENT
error | str | None | in | + | arg | Error message.

# RETURN
None

def tronverte.maya.core.status.Status.displayInfo

(

info = 'Action has been successfully executed.'

)

[static]

# DESCRIPTION
Display info by using maya.OpenMaya.MGlobal.displayInfo. If maya.OpenMaya.MGlobal is not available print will be used instead.

# ARGUMENT
info | str | 'Action has been successfully executed.' | in | * | arg | Info message.

# RETURN
None

def tronverte.maya.core.status.Status.displayWarning

(

warning

)

[static]

# DESCRIPTION
Display info by using maya.OpenMaya.MGlobal.displayWarning. If maya.OpenMaya.MGlobal is not available print will be used instead.

# ARGUMENTStatus.
warning | str | None | in | + | arg | Warning message.

# RETURN
None

---

The documentation for this class was generated from the following file:

• tronverte/maya/core/status.py