fib::cFibVariable Class Reference

#include <cFibVariable.h>

Collaboration diagram for fib::cFibVariable:

List of all members.

Public Member Functions
	cFibVariable (cFibElement *definingFibElement)
	cFibVariable (const cFibVariable &variable, cFibElement *definingFibElement=NULL)
virtual	~cFibVariable ()
doubleFib	getValue () const
longFib	getIntegerValue () const
void	setValue (const doubleFib dValue)
void	setIntegerValue (const longFib lValue)
cFibElement *	getDefiningElement () const
unsignedIntFib	getNumberOfUsingElements () const
set< cFibElement * >	getUsingElements () const
bool	isSet () const
bool	isIntegerValue () const
virtual bool	equal (const cFibVariable &variable) const
virtual bool	operator== (const cFibVariable &variable) const
virtual cFibVariable &	operator= (const cFibVariable &variable)

Protected Types
enum	eVariableType { UNDEFINED, REAL_VALUE, INTEGER_VALUE }

Protected Member Functions
void	registerUsingElement (iVariableUser *usingElement)
void	unregisterUsingElement (iVariableUser *usingElement)

Protected Attributes
eVariableType	variableType
doubleFib	doubleValue
longFib	integerValue
cFibElement *	pDefiningFibElement
set< iVariableUser * >	setUsingElements

Friends
class	cRoot
class	cArea
class	cFunction
class	cExtObject
class	cExtSubobject
class	cFibVector
class	cVectorFibSet
class	cVectorFibMatrix
class	cVectorExtObject
class	cVectorExtSubobject
class	cFunctionVariable

---

Detailed Description

Definition at line 62 of file cFibVariable.h.

---

Member Enumeration Documentation

enum fib::cFibVariable::eVariableType

protected

the type fore the type of the variable

Enumerator:

UNDEFINED
REAL_VALUE
INTEGER_VALUE

Definition at line 87 of file cFibVariable.h.

---

Constructor & Destructor Documentation

fib::cFibVariable::cFibVariable

(

cFibElement *

definingFibElement

)

The constructor of the variable.

Parameters:

definingFibElement

the Fib -element that defines the variable

fib::cFibVariable::cFibVariable	(	const cFibVariable &	variable,
		cFibElement *	definingFibElement = NULL
	)

The copyconstructor of the variable.

Parameters:

variable	the Fib -element that should be copied
definingFibElement	the Fib -element that defines the variable

virtual fib::cFibVariable::~cFibVariable ( )

virtual

The destructor of the variable.

---

Member Function Documentation

virtual bool fib::cFibVariable::equal ( const cFibVariable &  variable ) const

virtual

This Method checks if the given variable is equal to this variable.

Parameters:

variable

the variable to compare with this variable

Returns:

true if the given variable is equal to this variable, else false

cFibElement* fib::cFibVariable::getDefiningElement

(

)

const

This method returns a pointer to the Fib -element that defines the variable.

Returns:

a pointer to the Fib -element that defines the variable

longFib fib::cFibVariable::getIntegerValue

(

)

const

This method returns the value of the variable as an integer value. It returns 0 if the variable is undefined. If the value of the variable is an real value, the value is rounded to an integervalue.

Returns:

the value of the variable or 0 if the variable is undefined

unsignedIntFib fib::cFibVariable::getNumberOfUsingElements

(

)

const

This method returns the number of Fib -elements that uses the variable. These have to be registered befor.

Returns:

the number of Fib -elements that uses the variable

set<cFibElement*> fib::cFibVariable::getUsingElements

(

)

const

This method returns a set of Fib -elements that uses the variable. These have to be registered befor.

Returns:

a set Fib -elements that uses the variable

doubleFib fib::cFibVariable::getValue

(

)

const

This method returns the value of the variable as an real value. It returns 0 if the variable is undefined.

Returns:

the value of the variable or 0 if the variable is undefined

bool fib::cFibVariable::isIntegerValue

(

)

const

Returns:

if the value is an integer value true, else false

bool fib::cFibVariable::isSet

(

)

const

Returns:

if the value of the variable was set true is returned, else false

virtual cFibVariable& fib::cFibVariable::operator= ( const cFibVariable &  variable )

virtual

This Method makes this variable equal to the given variable.

Parameters:

variable

the variable to copy

virtual bool fib::cFibVariable::operator== ( const cFibVariable &  variable ) const

virtual

This Method checks if the given variable is equal to this variable.

Parameters:

variable

the variable to compare with this variable

Returns:

true if the given variable is equal to this variable, else false

void fib::cFibVariable::registerUsingElement ( iVariableUser *  usingElement )

protected

This method registers an element that uses the variable.

Parameters:

usingElement

the element that uses the variable

void fib::cFibVariable::setIntegerValue

(

const longFib

lValue

)

This method sets the value of the variable as an integer value.

Parameters:

lValue

the value of the variable to set

void fib::cFibVariable::setValue

(

const doubleFib

dValue

)

This method sets the value of the variable as an real value.

Parameters:

dValue

the value of the variable to set

void fib::cFibVariable::unregisterUsingElement ( iVariableUser *  usingElement )

protected

This method unregisters an element that don't uses the variable anymore.

Parameters:

usingElement

the element that don't uses the variable anymore

---

Friends And Related Function Documentation

friend class cArea

friend

Definition at line 67 of file cFibVariable.h.

friend class cExtObject

friend

Definition at line 69 of file cFibVariable.h.

friend class cExtSubobject

friend

Definition at line 70 of file cFibVariable.h.

friend class cFibVector

friend

Definition at line 71 of file cFibVariable.h.

friend class cFunction

friend

Definition at line 68 of file cFibVariable.h.

friend class cFunctionVariable

friend

Definition at line 76 of file cFibVariable.h.

friend class cRoot

friend

Definition at line 66 of file cFibVariable.h.

friend class cVectorExtObject

friend

Definition at line 74 of file cFibVariable.h.

friend class cVectorExtSubobject

friend

Definition at line 75 of file cFibVariable.h.

friend class cVectorFibMatrix

friend

Definition at line 73 of file cFibVariable.h.

friend class cVectorFibSet

friend

Definition at line 72 of file cFibVariable.h.

---

Member Data Documentation

doubleFib fib::cFibVariable::doubleValue

protected

the value if the variable is of type real

Definition at line 100 of file cFibVariable.h.

longFib fib::cFibVariable::integerValue

protected

the value if the variable is of type integer

Definition at line 105 of file cFibVariable.h.

cFibElement* fib::cFibVariable::pDefiningFibElement

protected

the refernce to the Fib -element that defines the variable

Definition at line 110 of file cFibVariable.h.

set<iVariableUser*> fib::cFibVariable::setUsingElements

protected

the set with the refernces to the Fib -elements that uses the variable

Definition at line 116 of file cFibVariable.h.

eVariableType fib::cFibVariable::variableType

protected

the type of the variable

Definition at line 95 of file cFibVariable.h.

---

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

• fib/incl/cFibVariable.h