Epetra_Object Class Reference

Epetra_Object: The base Epetra class. More...

#include <Epetra_Object.h>

Inheritance diagram for Epetra_Object:

[legend]
List of all members.

Constructors/destructor

 Epetra_Object (int TracebackModeIn=-1, bool set_label=true)
 Epetra_Object Constructor.
 Epetra_Object (const char *const Label, int TracebackModeIn=-1)
 Epetra_Object Constructor.
 Epetra_Object (const Epetra_Object &Object)
 Epetra_Object Copy Constructor.
virtual ~Epetra_Object ()
 Epetra_Object Destructor.

Attribute set/get methods

virtual void SetLabel (const char *const Label)
 Epetra_Object Label definition using char *.
virtual const char * Label () const
 Epetra_Object Label access funtion.
void SetTracebackMode (int TracebackModeValue)
 Set the value of the Epetra_Object error traceback report mode.
int GetTracebackMode ()
 Get the value of the Epetra_Object error report mode.

Miscellaneous

virtual void Print (ostream &os) const
 Print object to an output stream Print method.
virtual int ReportError (const string Message, int ErrorCode) const
 Error reporting method.

Static Public Attributes

int TracebackMode

Protected Member Functions

string toString (const int &x) const
string toString (const double &x) const

Private Member Functions

Epetra_Objectoperator= (const Epetra_Object &src)

Private Attributes

char * Label_

Detailed Description

Epetra_Object: 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.

Definition at line 45 of file Epetra_Object.h.


Constructor & Destructor Documentation

Epetra_Object::Epetra_Object int  TracebackModeIn = -1,
bool  set_label = true
 

Epetra_Object Constructor.

Epetra_Object is the primary base class in Epetra. All Epetra class are derived from it, directly or indirectly. This class is seldom used explictly.

Definition at line 34 of file Epetra_Object.cpp.

Epetra_Object::Epetra_Object const char *const   Label,
int  TracebackModeIn = -1
 

Epetra_Object Constructor.

Creates a Epetra_Object with the given label.

Definition at line 44 of file Epetra_Object.cpp.

Epetra_Object::Epetra_Object const Epetra_Object Object  ) 
 

Epetra_Object Copy Constructor.

Makes an exact copy of an existing Epetra_Object instance.

Definition at line 52 of file Epetra_Object.cpp.

Epetra_Object::~Epetra_Object  )  [virtual]
 

Epetra_Object Destructor.

Completely deletes a Epetra_Object object.

Definition at line 94 of file Epetra_Object.cpp.


Member Function Documentation

void Epetra_Object::SetLabel const char *const   Label  )  [virtual]
 

Epetra_Object Label definition using char *.

Defines the label used to describe the this object.

Definition at line 106 of file Epetra_Object.cpp.

const char * Epetra_Object::Label  )  const [virtual]
 

Epetra_Object Label access funtion.

Returns the string used to define this object.

Reimplemented in Epetra_BasicRowMatrix, Epetra_CrsMatrix, Epetra_JadOperator, Epetra_SerialDenseMatrix, Epetra_SerialDenseSVD, and Epetra_VbrMatrix.

Definition at line 102 of file Epetra_Object.cpp.

void Epetra_Object::SetTracebackMode int  TracebackModeValue  )  [static]
 

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.

Definition at line 61 of file Epetra_Object.cpp.

int Epetra_Object::GetTracebackMode  )  [static]
 

Get the value of the Epetra_Object error report mode.

Definition at line 66 of file Epetra_Object.cpp.

void Epetra_Object::Print ostream &  os  )  const [virtual]
 

Print object to an output stream Print method.

Reimplemented in Epetra_BasicRowMatrix, Epetra_BlockMap, Epetra_CrsGraph, Epetra_CrsMatrix, Epetra_DistObject, Epetra_Export, Epetra_Import, Epetra_IntSerialDenseMatrix, Epetra_IntSerialDenseVector, Epetra_IntVector, Epetra_JadOperator, Epetra_MapColoring, Epetra_MpiComm, Epetra_MpiDistributor, Epetra_MpiSmpComm, Epetra_MultiVector, Epetra_OffsetIndex, Epetra_SerialComm, Epetra_SerialDenseMatrix, Epetra_SerialDenseSolver, Epetra_SerialDenseSVD, Epetra_SerialDenseVector, Epetra_SerialDistributor, and Epetra_VbrMatrix.

Definition at line 73 of file Epetra_Object.cpp.

int Epetra_Object::ReportError const string  Message,
int  ErrorCode
const [virtual]
 

Error reporting method.

Definition at line 79 of file Epetra_Object.cpp.

string Epetra_Object::toString const int &  x  )  const [inline, protected]
 

Definition at line 129 of file Epetra_Object.h.

string Epetra_Object::toString const double &  x  )  const [inline, protected]
 

Definition at line 135 of file Epetra_Object.h.

Epetra_Object& Epetra_Object::operator= const Epetra_Object src  )  [inline, private]
 

Definition at line 143 of file Epetra_Object.h.


Member Data Documentation

int Epetra_Object::TracebackMode [static]
 

char* Epetra_Object::Label_ [private]
 

Definition at line 148 of file Epetra_Object.h.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:38:06 2008 for Epetra Package Browser (Single Doxygen Collection) by doxygen 1.3.9.1