fib::cFunctionExp Class Reference

#include <cFunctionExp.h>

Inheritance diagram for fib::cFunctionExp:

Collaboration diagram for fib::cFunctionExp:

List of all members.

Public Member Functions
	cFunctionExp (const cUnderFunction &firstUnderfunction, const cUnderFunction &secondUnderfunction, cUnderFunction *pInSuperiorFunction=NULL, cFibElement *pInDefiningFibElement=NULL)
	cFunctionExp (const cFunctionExp &underfunction, cUnderFunction *pInSuperiorFunction=NULL, cFibElement *pInDefiningFibElement=NULL)
	cFunctionExp (const TiXmlElement *pXmlElement, intFib &outStatus, list< cFibVariable * > &liDefinedVariables, cUnderFunction *pInSuperiorFunction=NULL, cFibElement *pInDefiningFibElement=NULL)
	cFunctionExp (cReadBits &iBitStream, intFib &outStatus, list< cFibVariable * > &liDefinedVariables, const cDomainSingle *pInDomainValue, const cDomainSingle *pInDomainVariable, cUnderFunction *pInSuperiorFunction=NULL, cFibElement *pInDefiningFibElement=NULL)
virtual doubleFib	getValue () const
virtual bool	store (ostream &stream, char &cRestBits, unsigned char &uiRestBitPosition) const
virtual unsignedIntFib	getType () const
virtual string	getUnderFunctionName () const
virtual cFunctionExp *	clone (cUnderFunction *pInSuperiorUnderFunction=NULL, cFibElement *pInDefiningFibElement=NULL) const
Public Member Functions inherited from fib::cFunctionTwoValue
	cFunctionTwoValue (const cUnderFunction &firstUnderfunction, const cUnderFunction &secondUnderfunction, cUnderFunction *pInSuperiorFunction=NULL, cFibElement *pInDefiningFibElement=NULL)
	cFunctionTwoValue (cUnderFunction *pInFirstUnderfunction, cUnderFunction *pInSecondUnderfunction, cUnderFunction *pInSuperiorFunction=NULL, cFibElement *pInDefiningFibElement=NULL)
	cFunctionTwoValue (const cFunctionTwoValue &underfunction, cUnderFunction *pInSuperiorFunction=NULL, cFibElement *pInDefiningFibElement=NULL)
	cFunctionTwoValue (const TiXmlElement *pXmlElement, intFib &outStatus, list< cFibVariable * > &liDefinedVariables, cUnderFunction *pInSuperiorFunction=NULL, cFibElement *pInDefiningFibElement=NULL)
	cFunctionTwoValue (cReadBits &iBitStream, intFib &outStatus, list< cFibVariable * > &liDefinedVariables, const cDomainSingle *pInDomainValue, const cDomainSingle *pInDomainVariable, cUnderFunction *pInSuperiorFunction=NULL, cFibElement *pInDefiningFibElement=NULL)
virtual	~cFunctionTwoValue ()
cUnderFunction *	getFirstUnderFunction ()
const cUnderFunction *	getFirstUnderFunction () const
void	setFirstUnderFunction (const cUnderFunction &underFunction, bool bDeleteOld=true)
cUnderFunction *	getSecondUnderFunction ()
const cUnderFunction *	getSecondUnderFunction () const
void	setSecondUnderFunction (const cUnderFunction &underFunction, bool bDeleteOld=true)
virtual bool	isValid () const
virtual bool	isUsedVariable (const cFibVariable *variable) const
virtual set< cFibVariable * >	getUsedVariables ()
virtual bool	replaceVariable (cFibVariable *variableOld, cFibVariable *variableNew)
virtual unsignedIntFib	getNumberOfUnderFunctions () const
virtual void	setDefiningFibElement (cFibElement *fibElement=NULL, bool bCheckDomains=true)
virtual unsignedLongFib	getTimeNeed (unsignedLongFib lMaxTime=0) const
virtual unsignedLongFib	getCompressedSize () const
virtual bool	storeXml (ostream &stream) const
virtual bool	equal (const cUnderFunction &underfunction) const
Public Member Functions inherited from fib::cUnderFunction
virtual	~cUnderFunction ()
virtual cTypeElement *	getElementType () const
virtual cDomainSingle *	getDomain () const
virtual cDomainSingle *	getValueDomain () const
virtual cDomainSingle *	getStandardDomain () const
virtual cDomainSingle *	getVariableDomain () const
cFibElement *	getDefiningFibElement () const
cUnderFunction *	getSuperiorUnderFunction () const
virtual bool	operator== (const cUnderFunction &underfunction) const
bool	operator!= (const cUnderFunction &underfunction) const

Additional Inherited Members
Protected Attributes inherited from fib::cFunctionTwoValue
cUnderFunction *	pFirstUnderfunction
cUnderFunction *	pSecondUnderfunction
Protected Attributes inherited from fib::cUnderFunction
cUnderFunction *	pSuperiorUnderFunction
cFibElement *	pDefiningFibElement

---

Detailed Description

Definition at line 50 of file cFunctionExp.h.

---

Constructor & Destructor Documentation

fib::cFunctionExp::cFunctionExp	(	const cUnderFunction &	firstUnderfunction,
		const cUnderFunction &	secondUnderfunction,
		cUnderFunction *	pInSuperiorFunction = NULL,
		cFibElement *	pInDefiningFibElement = NULL
	)

The constructor of the underfunction.

Parameters:

firstUnderfunction

the first underfunction for the function

See also:

pFirstUnderfunction

Parameters:

secondUnderfunction

the second underfunction for the function

See also:

pSecondUnderfunction

Parameters:

pInSuperiorFunction	the underfunction which contains the new underfunction
pInDefiningFibElement	the fib -element which defines/ uses the new underfunction

fib::cFunctionExp::cFunctionExp	(	const cFunctionExp &	underfunction,
		cUnderFunction *	pInSuperiorFunction = NULL,
		cFibElement *	pInDefiningFibElement = NULL
	)

The copy constructor of the underfunction. This constructor will also copy the underfunctions of the given function.

Parameters:

underfunction	the underfunction which to copy
pInSuperiorFunction	the underfunction which contains the new underfunction
pInDefiningFibElement	the fib -element which defines/ uses the new underfunction

fib::cFunctionExp::cFunctionExp	(	const TiXmlElement *	pXmlElement,
		intFib &	outStatus,
		list< cFibVariable * > &	liDefinedVariables,
		cUnderFunction *	pInSuperiorFunction = NULL,
		cFibElement *	pInDefiningFibElement = NULL
	)

The constructor for restoring a value underfunction from an TinyXml element.

Parameters:

pXmlNode	a pointer to the TinyXml node the underfunction is stored in
outStatus	An reference to an integervalue where the errorvalue can be stored to. possible errorvalues are: 0 loading successful -1 loading error, invalid pXmlElement -2 loading error, invalid data in pXmlElement 1 loading warning, invalid data in pXmlElement, error could be corrected 2 loading warning, invalid data in pXmlElement, maybe the loaded object is wrong
liDefinedVariables	a list with the defined variables for the to restore fib -element, every variable should have it's number (the number under which it is stored) as it's value
pInSuperiorFunction	the underfunction which contains the new underfunction
pInDefiningFibElement	the fib -element which defines/ uses the new underfunction

fib::cFunctionExp::cFunctionExp	(	cReadBits &	iBitStream,
		intFib &	outStatus,
		list< cFibVariable * > &	liDefinedVariables,
		const cDomainSingle *	pInDomainValue,
		const cDomainSingle *	pInDomainVariable,
		cUnderFunction *	pInSuperiorFunction = NULL,
		cFibElement *	pInDefiningFibElement = NULL
	)

This constructor restores a value underfunction from the stream where it is stored in the compressed fib -format. Beware: The bits for the functiontype should be allready readed, this constructor reads yust the two underfunctions.

Parameters:

iBitStream	the stream where this underfunction is stored to in, because this stream is an cReadBits, any number of bits can be readed from it
outStatus	An reference to an integervalue where the errorvalue can be stored to. If the pointer is NULL no errorvalue will be given back. possible errorvalues are: 0 loading successful -1 loading error, invalid stream -2 loading error, invalid data in stream 1 loading warning, invalid data in stream, error could be corrected 2 loading warning, invalid data in stream, maybe the loaded object is wrong
liDefinedVariables	a list with the defined variables for the to restore fib -element, every variable should have it's number (the number under which it is stored) as it's value
pInDomainValue	the domain for value underfunction
pInDomainVariable	the domain for variables
pInSuperiorFunction	the underfunction which contains the new underfunction
pInDefiningFibElement	the fib -element which defines/ uses the new underfunction

---

Member Function Documentation

virtual cFunctionExp* fib::cFunctionExp::clone ( cUnderFunction *  pInSuperiorUnderFunction = NULL, cFibElement *  pInDefiningFibElement = NULL  ) const

virtual

This method duplicates this whole underfunction. Underfunctions of this underfunction are also cloned.

Parameters:

pSuperiorUnderFunction	the underfunction which contains
pInDefiningFibElement	the Fib -element which defines/ uses

Returns:

the cloned/ duplicated underfunction

Implements fib::cUnderFunction.

virtual unsignedIntFib fib::cFunctionExp::getType ( ) const

virtual

Returns:

the type for the underfunction

Implements fib::cUnderFunction.

virtual string fib::cFunctionExp::getUnderFunctionName ( ) const

virtual

Returns:

the name for the underfunction

Implements fib::cUnderFunction.

virtual doubleFib fib::cFunctionExp::getValue ( ) const

virtual

Returns the value of the underfunction or 0 if non such exists.

Returns:

the value of the underfunction or 0 if non such exists

Implements fib::cUnderFunction.

virtual bool fib::cFunctionExp::store ( ostream &  stream, char &  cRestBits, unsigned char &  uiRestBitPosition  ) const

virtual

This method stores this Fib -object in the compressed Fib -format into the given stream. It is needed becouse the stream can yust store byts but the size of fib -elements can be any number of bits. Because of that ther have to be a possibility to exchange the missing bits betwean the fib -elements.

See also:

store

Parameters:

stream	the stream where this Fib -object should be stored to
cRestBits	the not yet writen bits which should be stored
uiRestBitPosition	the number of bits in the cRestBits which should be writen respectively containing valid information

Returns:

true if this Fib -object is stored, else false

Implements fib::cUnderFunction.

---

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

• fib/incl/cFunctionExp.h