Teuchos - Trilinos Tools Package Version of the Day
Related Functions
Teuchos::Object Class Reference

The base Teuchos class. More...

#include <Teuchos_Object.hpp>

Inheritance diagram for Teuchos::Object:
Teuchos::SerialDenseMatrix< OrdinalType, ScalarType > Teuchos::SerialDenseSolver< OrdinalType, ScalarType > Teuchos::SerialSpdDenseSolver< OrdinalType, ScalarType > Teuchos::SerialSymDenseMatrix< OrdinalType, ScalarType > Teuchos::SerialDenseVector< OrdinalType, ScalarType >

List of all members.

Public Member Functions

Constructors/Destructor.
 Object (int tracebackModeIn=-1)
 Default Constructor.
 Object (const char *label, int tracebackModeIn=-1)
 Labeling Constructor.
 Object (const Object &obj)
 Copy Constructor.
virtual ~Object ()
 Destructor.
I/O method.
virtual void print (std::ostream &os) const
 Print method for placing the object in an output stream.
Error reporting method.
virtual int reportError (const std::string message, int errorCode) const
 Method for reporting errors with Teuchos objects.

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const Teuchos::Object &Obj)

Set methods.

virtual void setLabel (const char *label)
 Define object label using a character std::string.
static void setTracebackMode (int tracebackModeValue)
 Set the value of the Object error traceback report mode.

Accessor methods.

virtual char * label () const
 Access the object label.
static int getTracebackMode ()
 Get the value of the Object error traceback report mode.

Detailed Description

The base Teuchos class.

The Object class provides capabilities common to all Teuchos objects, such as a label that identifies an object instance, constant definitions, enum types.

Definition at line 56 of file Teuchos_Object.hpp.


Constructor & Destructor Documentation

Teuchos::Object::Object ( int  tracebackModeIn = -1)

Default Constructor.

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

Definition at line 37 of file Teuchos_Object.cpp.

Teuchos::Object::Object ( const char *  label,
int  tracebackModeIn = -1 
)

Labeling Constructor.

Creates an Object with the given label.

Definition at line 43 of file Teuchos_Object.cpp.

Teuchos::Object::Object ( const Object obj)

Copy Constructor.

Makes an exact copy of an existing Object instance.

Definition at line 49 of file Teuchos_Object.cpp.

Teuchos::Object::~Object ( ) [virtual]

Destructor.

Completely deletes an Object object.

Definition at line 76 of file Teuchos_Object.cpp.


Member Function Documentation

void Teuchos::Object::setLabel ( const char *  label) [virtual]

Define object label using a character std::string.

Defines the label used to describe this object.

Definition at line 89 of file Teuchos_Object.cpp.

void Teuchos::Object::setTracebackMode ( int  tracebackModeValue) [static]

Set the value of the 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.

Note:
Default is set to -1 when object is constructed.

Definition at line 56 of file Teuchos_Object.cpp.

char * Teuchos::Object::label ( ) const [virtual]

Access the object label.

Returns the std::string used to define this object.

Definition at line 84 of file Teuchos_Object.cpp.

int Teuchos::Object::getTracebackMode ( ) [static]

Get the value of the Object error traceback report mode.

Definition at line 63 of file Teuchos_Object.cpp.

void Teuchos::Object::print ( std::ostream &  os) const [virtual]
virtual int Teuchos::Object::reportError ( const std::string  message,
int  errorCode 
) const [inline, virtual]

Method for reporting errors with Teuchos objects.

Definition at line 134 of file Teuchos_Object.hpp.


Friends And Related Function Documentation

std::ostream & operator<< ( std::ostream &  os,
const Teuchos::Object Obj 
) [related]

Output stream operator for handling the printing of Object.

Definition at line 169 of file Teuchos_Object.hpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines