SPARK::TObject Class Reference

Class used to represent an instance of an inverse. More...

#include <object.h>

List of all members.

Public Member Functions
Access methods
unsigned	GetHandle () const
	Returns unique handle as specified in XML file.
unsigned	GetInstanceHandle () const
	Returns unique inverse handle set by SPARK::TInverse object for each instance.
const char *	GetName () const
	Returns name of object as specified in XML file as const char* .
const char *	GetActiveCallbackName () const
	Returns the name of the currently active callback, Returns "" if none active!
SPARK::TInverse *	GetInverse ()
	Returns name of SPARK::TInverse this object is an instance of.
const SPARK::TProblem *	GetProblem () const
	Returns pointer to SPARK::TProblem object this object belongs to.
const SPARK::TComponent *	GetComponent () const
	Returns pointer to SPARK::TComponent object this object belongs to.
double	GetTolerance () const
	Returns value of relative tolerance curently used by solver.
Data methods
void *	GetData ()
	Returns private data associated with this instance as void* .
void	SetData (void *address)
	Sets the private data to address.

---

Detailed Description

Class used to represent an instance of an inverse.

Note:

Static callbacks do not require argument lists

---

Member Function Documentation

unsigned SPARK::TObject::GetHandle (   )  const [inline]

Returns unique handle as specified in XML file.

unsigned SPARK::TObject::GetInstanceHandle (   )  const [inline]

Returns unique inverse handle set by SPARK::TInverse object for each instance.

const char* SPARK::TObject::GetName (   )  const

Returns name of object as specified in XML file as const char* .

const char* SPARK::TObject::GetActiveCallbackName (   )  const

Returns the name of the currently active callback, Returns "" if none active!

SPARK::TInverse* SPARK::TObject::GetInverse (   )

Returns name of SPARK::TInverse this object is an instance of.

const SPARK::TProblem* SPARK::TObject::GetProblem (   )  const

Returns pointer to SPARK::TProblem object this object belongs to.

const SPARK::TComponent* SPARK::TObject::GetComponent (   )  const

Returns pointer to SPARK::TComponent object this object belongs to.

double SPARK::TObject::GetTolerance (   )  const

Returns value of relative tolerance curently used by solver.

void* SPARK::TObject::GetData (   )  [inline]

Returns private data associated with this instance as void* .

void SPARK::TObject::SetData (  void *  address  )  [inline]

Sets the private data to address.

---

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

• object.h

---