Teuchos::Object Class Reference

The base Teuchos class. More...

#include <Teuchos_Object.hpp>

Inheritance diagram for Teuchos::Object:

List of all members.

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.
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)

---

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.

---

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.

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

Labeling Constructor.

Creates an Object with the given label.

Teuchos::Object::Object

(

const Object &

obj

)

Copy Constructor.

Makes an exact copy of an existing Object instance.

Teuchos::Object::~Object

(

)

[virtual]

Destructor.

Completely deletes an Object object.

---

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.

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.

char * Teuchos::Object::label

(

)

const [virtual]

Access the object label.

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

int Teuchos::Object::getTracebackMode

(

)

[static]

Get the value of the Object error traceback report mode.

void Teuchos::Object::print

(

std::ostream &

os

)

const [virtual]

Print method for placing the object in an output stream.

Reimplemented in Teuchos::SerialDenseMatrix< OrdinalType, ScalarType >, and Teuchos::SerialDenseVector< OrdinalType, ScalarType >.

virtual int Teuchos::Object::reportError	(	const std::string	message,
		int	errorCode
	)			const [inline, virtual]

Method for reporting errors with Teuchos objects.

---

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.

---

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

• Teuchos_Object.hpp
• Teuchos_Object.cpp

---