Inheritance diagram for PyTrilinos.Epetra.Object:

Collaboration diagram for PyTrilinos.Epetra.Object:

Public Member Functions
def	__init__
def	SetLabel
def	Label
def	SetTracebackMode
def	GetTracebackMode
def	GetTracebackStream
def	ReportError
def	__str__
def	Print
Public Attributes
	this

Detailed Description

The base Epetra class.
    
The Epetra_Object class provides capabilities common to all Epetra
objects, such as a label that identifies an object instance, constant
definitions, enum types.  In C++, it supports a ``Print()`` method
that takes an output stream as an argument.  In the python
implementation for this and all derived classes, this method takes an
optional file object argument whose default value is standard out.

Constructor & Destructor Documentation

def PyTrilinos.Epetra.Object.__init__	(	self,
		args
	)

__init__(Epetra_Object self, int TracebackModeIn=-1, bool set_label=True) -> Object
__init__(Epetra_Object self, char const *const Label, int TracebackModeIn=-1) -> Object
__init__(Epetra_Object self, Object Object) -> Object

Epetra_Object::Epetra_Object(const Epetra_Object &Object)

Epetra_Object Copy Constructor.

Makes an exact copy of an existing Epetra_Object instance.

Member Function Documentation

def PyTrilinos.Epetra.Object.__str__	(	self,
		args
	)

__str__(Object self) -> PyObject *

Returns the results of ``Print()`` in a string, so that
the python ``print`` command will work on ``Epetra`` objects.  The
``Print()`` methods are designed to run correctly in parallel, so do
not execute ``print`` on an Epetra object conditionally on the
processor number.  For example, do not do

  ``if comm.MyPID() == 0: print epetra_obj``

or it will hang your code.

def PyTrilinos.Epetra.Object.GetTracebackMode ( args )

GetTracebackMode() -> int

int
Epetra_Object::GetTracebackMode()

Get the value of the Epetra_Object error report mode.

def PyTrilinos.Epetra.Object.GetTracebackStream ( args )

GetTracebackStream() -> std::ostream &

std::ostream & Epetra_Object::GetTracebackStream()

Get the output stream for error reporting.

def PyTrilinos.Epetra.Object.Label	(	self,
		args
	)

Label(Object self) -> char const *

const char *
Epetra_Object::Label() const

Epetra_Object Label access funtion.

Returns the string used to define this object.

Reimplemented in PyTrilinos.Epetra.VbrMatrix, PyTrilinos.Epetra.CrsMatrix, and PyTrilinos.Epetra.BasicRowMatrix.

def PyTrilinos.Epetra.Object.Print	(	self,
		args
	)

Print(Object self, PyObject * pf=None)

void
Epetra_Object::Print(ostream &os) const

Print object to an output stream Print method

def PyTrilinos.Epetra.Object.ReportError	(	self,
		args
	)

ReportError(Object self, string const Message, int ErrorCode) -> int

int
Epetra_Object::ReportError(const string Message, int ErrorCode) const

Error reporting method.

def PyTrilinos.Epetra.Object.SetLabel	(	self,
		args
	)

SetLabel(Object self, char const *const Label)

void
Epetra_Object::SetLabel(const char *const Label)

Epetra_Object Label definition using char *.

Defines the label used to describe the this object.

def PyTrilinos.Epetra.Object.SetTracebackMode ( args )

SetTracebackMode(int TracebackModeValue)

void
Epetra_Object::SetTracebackMode(int TracebackModeValue)

Set the value of the Epetra_Object error traceback report mode.

Sets the integer error traceback behavior. TracebackMode controls
whether or not traceback information is printed when run time integer
errors are detected:

<= 0 - No information report

= 1 - Fatal (negative) values are reported

>= 2 - All values (except zero) reported.

Default is set to 1.

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

Epetra.py

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation