SPARK::TInverse Class Reference

Class that defines the callbacks for an inverse. More...

#include <inverse.h>

List of all members.

Public Member Functions
Access methods
unsigned	GetHandle () const
	Returns unique inverse handle as specified in XML file.
const char *	GetName () const
	Returns name of inverse as specified in XML file as const char* .
const char *	GetAtomicClassName () const
	Returns class name as specified in XML file as const char* .
const char *	GetFileName () const
	Returns file name of atomic class where the inverse is declared as const char* .
SPARK::AtomicTypes	GetAtomicType () const
	Returns the type of the inverse as SPARK::AtomicTypes.
const char *	GetActiveCallbackName () const
	Returns the name of the currently active callback, Returns "" if none active!
unsigned	GetNumObjects () const
	Returns the number of TObject instances of this inverse.
SPARK::TObject *	GetObject (unsigned idx)
	Returns instance idx as a SPARK::TObject pointer.
const SPARK::TProblem *	GetProblem () const
	Returns pointer to SPARK::TProblem object this inverse belongs to.
double	GetTolerance () const
	Returns value of relative tolerance currently used by solver.
Data methods
void *	GetStaticData ()
	Returns static private data as void* .
void	SetStaticData (void *address)
	Sets the static private data to address.

---

Detailed Description

Class that defines the callbacks for an inverse.

Also contains all instances as SPARK::TObject objects of an inverse, as well as the void* pointer to the static data.

---

Member Function Documentation

unsigned SPARK::TInverse::GetHandle (   )  const

Returns unique inverse handle as specified in XML file.

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

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

const char* SPARK::TInverse::GetAtomicClassName (   )  const

Returns class name as specified in XML file as const char* .

const char* SPARK::TInverse::GetFileName (   )  const

Returns file name of atomic class where the inverse is declared as const char* .

SPARK::AtomicTypes SPARK::TInverse::GetAtomicType (   )  const

Returns the type of the inverse as SPARK::AtomicTypes.

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

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

unsigned SPARK::TInverse::GetNumObjects (   )  const

Returns the number of TObject instances of this inverse.

SPARK::TObject* SPARK::TInverse::GetObject (  unsigned  idx  )

Returns instance idx as a SPARK::TObject pointer.

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

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

double SPARK::TInverse::GetTolerance (   )  const

Returns value of relative tolerance currently used by solver.

void* SPARK::TInverse::GetStaticData (   )  [inline]

Returns static private data as void* .

void SPARK::TInverse::SetStaticData (  void *  address  )  [inline]

Sets the static private data to address.

---

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

• inverse.h

---