sStash.stashLib.Error Class Reference

[ CLASS ] - Error class. More...

Inheritance diagram for sStash.stashLib.Error:

Public Member Functions
def	__init__ (self, errorMessage=None)
	Constructor. More...
def	__str__ (self)
	String representation. More...
def	setError (self, errorMessage)
	Sets error. More...
Properties
def	designator (self)
	Designator. More...
def	module (self)
	Module. More...
def	number (self)
	Number. More...
def	category (self)
	Category. More...
def	message (self)
	Message. More...
def	errorMessage (self)
	Error message. More...

Detailed Description

[ CLASS ] - Error class.

Constructor & Destructor Documentation

__init__()

def sStash.stashLib.Error.__init__	(		self,
			errorMessage = None
	)

Constructor.

Parameters

errorMessage

[ str | None | in ] - Error message.

Exceptions

N/A

Returns

None - None.

Member Function Documentation

__str__()

def sStash.stashLib.Error.__str__

(

self

)

String representation.

Exceptions

N/A

Returns

str - String representation.

designator()

def sStash.stashLib.Error.designator

(

self

)

Designator.

Exceptions

N/A

Returns

str - Designator.

module()

def sStash.stashLib.Error.module

(

self

)

Module.

Exceptions

N/A

Returns

str - Module.

number()

def sStash.stashLib.Error.number

(

self

)

Number.

Exceptions

N/A

Returns

str - Number.

category()

def sStash.stashLib.Error.category

(

self

)

Category.

Exceptions

N/A

Returns

str - Category.

message()

def sStash.stashLib.Error.message

(

self

)

Message.

Exceptions

N/A

Returns

str - Message.

errorMessage()

def sStash.stashLib.Error.errorMessage

(

self

)

Error message.

Exceptions

N/A

Returns

str - Error message.

setError()

def sStash.stashLib.Error.setError	(		self,
			errorMessage
	)

Sets error.

Method will return True if given error is in valid format, False otherwise.

Parameters

errorMessage

[ str | None | in ] - Error message.

Exceptions

N/A

Returns

bool - Result.

---

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

• sStash/python/sStash/stashLib.py