python.trfExitCodes.trfExitCode Class Reference

Little class to hold the three attributes of a transform error. More...

Inheritance diagram for python.trfExitCodes.trfExitCode:

Collaboration diagram for python.trfExitCodes.trfExitCode:

Public Member Functions
	__init__ (self, acronymn, numcode, description, signalname="")
	Exit code class instantiation.
	acronymn (self)
	numcode (self)
	description (self)
	signalname (self)

Protected Attributes
	_acronymn = acronymn
	_numcode = numcode
	_description = description
	_signalname = signalname

Detailed Description

Little class to hold the three attributes of a transform error.

Definition at line 17 of file trfExitCodes.py.

Constructor & Destructor Documentation

__init__()

python.trfExitCodes.trfExitCode.__init__	(		self,
			acronymn,
			numcode,
			description,
			signalname = "" )

Exit code class instantiation.

Parameters

acronymn	The internal transform acronymn for this error code
numcode	The numerical exit code for this error
description	A human comprehensible description of this error's meaning
signame	The original signal name (only relevant for signals)

Definition at line 24 of file trfExitCodes.py.

    def __init__(self, acronymn, numcode, description, signalname = ""):
        self._acronymn = acronymn
        self._numcode = numcode
        self._description = description
        self._signalname = signalname
        

Member Function Documentation

acronymn()

python.trfExitCodes.trfExitCode.acronymn

(

self

)

Definition at line 31 of file trfExitCodes.py.

    def acronymn(self):
        return self._acronymn
    

description()

python.trfExitCodes.trfExitCode.description

(

self

)

Definition at line 39 of file trfExitCodes.py.

    def description(self):
        return self._description
 

numcode()

python.trfExitCodes.trfExitCode.numcode

(

self

)

Definition at line 35 of file trfExitCodes.py.

    def numcode(self):
        return self._numcode
    

signalname()

python.trfExitCodes.trfExitCode.signalname

(

self

)

Definition at line 43 of file trfExitCodes.py.

    def signalname(self):
        return self._signalname
 

Member Data Documentation

_acronymn

python.trfExitCodes.trfExitCode._acronymn = acronymn

protected

Definition at line 25 of file trfExitCodes.py.

_description

python.trfExitCodes.trfExitCode._description = description

protected

Definition at line 27 of file trfExitCodes.py.

_numcode

python.trfExitCodes.trfExitCode._numcode = numcode

protected

Definition at line 26 of file trfExitCodes.py.

_signalname

python.trfExitCodes.trfExitCode._signalname = signalname

protected

Definition at line 28 of file trfExitCodes.py.

---

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

• trfExitCodes.py