#include <cVectorArea.h>

Inheritance diagram for fib::cVectorArea:

Collaboration diagram for fib::cVectorArea:

Public Member Functions
	cVectorArea (cFibElement *pInDefiningElement=NULL)
	cVectorArea (const cVectorArea &vector, cFibElement *pInDefiningElement=NULL)
	cVectorArea (longFib lLowerBound, longFib lUpperBound, cFibElement *pInDefiningElement=NULL)
	cVectorArea (longFib lLowerBound, cFibVariable pVariableUpperBound, cFibElement pInDefiningElement=NULL)
	cVectorArea (cFibVariable pVariableLowerBound, longFib lUpperBound, cFibElement pInDefiningElement=NULL)
	cVectorArea (cFibVariable pVariableLowerBound, cFibVariable pVariableUpperBound, cFibElement *pInDefiningElement=NULL)
	cVectorArea (const TiXmlElement pXmlElement, intFib &outStatus, list< cFibVariable > &liDefinedVariables)
	cVectorArea (cReadBits &iBitStream, intFib &outStatus, list< cFibVariable * > &liDefinedVariables, const cDomain pInVectorDomain, const cDomain pInDomainVariable)
virtual cVectorArea *	createInstance (unsignedIntFib iNumberOfElements=2, cFibElement *definingAreaElement=NULL) const
virtual void	setDefiningFibElement (cFibElement *fibElement=NULL, bool bCheckDomains=true)
virtual cTypeElement *	getElementType () const
virtual cDomainVectorBasis *	getDomain () const
virtual cDomainVectorBasis *	getStandardDomain () const
virtual cDomainVectorBasis *	getValueDomain () const
virtual string	getVectorType () const
longFib	getLowerBound () const
longFib	getUpperBound () const
list< longFib >	getAreaValues () const
bool	setLowerBoundValue (longFib lValue)
bool	setUpperBoundValue (longFib lValue)
bool	setLowerBoundVariable (cFibVariable *pVariable)
bool	setUpperBoundVariable (cFibVariable *pVariable)
virtual cVectorArea &	operator= (const cFibVector &vector)
Public Member Functions inherited from fib::cFibVector
virtual	~cFibVector ()
unsignedIntFib	getNumberOfElements () const
virtual bool	isVariable (unsignedIntFib iNumberElement) const
virtual bool	isUsedVariable (const cFibVariable *variable) const
virtual set< cFibVariable * >	getUsedVariables ()
virtual bool	replaceVariable (cFibVariable variableOld, cFibVariable variableNew)
virtual doubleFib	getValue (unsignedIntFib iNumberElement) const
virtual bool	setValue (unsignedIntFib iNumberElement, doubleFib dValue)
virtual cFibVariable *	getVariable (unsignedIntFib iNumberElement)
virtual bool	setVariable (unsignedIntFib iNumberElement, cFibVariable *pVariable)
virtual cDomain *	getDomain (unsignedIntFib iNumberElement) const
virtual cDomainSingle *	getVariableDomain () const
cFibElement *	getDefiningFibElement () const
virtual unsignedLongFib	getCompressedSize () const
virtual unsignedLongFib	getCompressedSize (const cDomainVectorBasis &valueVectorDomain, const cDomainSingle &variableDomain) const
virtual bool	store (ostream &stream, char &cRestBits, unsigned char &uiRestBitPosition) const
virtual bool	store (ostream &stream, char &cRestBits, unsigned char &uiRestBitPosition, const cDomainVectorBasis &valueVectorDomain, const cDomainSingle &variableDomain) const
virtual bool	storeXml (ostream &stream) const
virtual bool	equal (const cFibVector &vector) const
virtual bool	operator== (const cFibVector &vector) const
bool	operator!= (const cFibVector &vector) const
virtual bool	operator< (const cFibVector &vector) const

Additional Inherited Members
Static Public Member Functions inherited from fib::cFibVector
static bool	lowerVector (const cFibVector &vector1, const cFibVector &vector2)
Protected Types inherited from fib::cFibVector
enum	eVectorType { VALUE, VARIABLE }
Protected Member Functions inherited from fib::cFibVector
	cFibVector (unsignedIntFib iNumberOfVectorElements=1, cFibElement *definingFibElement=NULL)
	cFibVector (const cFibVector &vector, cFibElement *definingFibElement=NULL)
	cFibVector (const TiXmlElement pXmlElement, intFib &outStatus, list< cFibVariable > &liDefinedVariables)
	cFibVector (cReadBits &iBitStream, intFib &outStatus, list< cFibVariable * > &liDefinedVariables, const cDomain pInVectorDomain, const cDomain pInDomainVariable, const unsignedIntFib uiInNumberOfElements=0)
virtual cFibElement *	getVariableUsingFibElement () const
virtual bool	deleteVariable (cFibVariable *pVariable)
Protected Attributes inherited from fib::cFibVector
vector< eVectorType >	liVectorType
vector< doubleFib >	liVectorValues
vector< cFibVariable * >	liVectorVariable
cFibElement *	pDefiningFibElement

Detailed Description

Definition at line 57 of file cVectorArea.h.

Constructor & Destructor Documentation

fib::cVectorArea::cVectorArea ( cFibElement * pInDefiningElement = NULL )

The constructor of the subareavector.

Parameters:

pInDefiningElement the Fib-element which defines/ uses the checksum -property -vector

fib::cVectorArea::cVectorArea	(	const cVectorArea &	vector,
		cFibElement *	pInDefiningElement = `NULL`
	)

The copy constructor of the vector.

Parameters:

vector	the vector from which to copy the data
pInDefiningElement	the Fib-element which defines/ uses the new vector

fib::cVectorArea::cVectorArea	(	longFib	lLowerBound,
		longFib	lUpperBound,
		cFibElement *	pInDefiningElement = `NULL`
	)

parameterconstructor

Parameters:

lLowerBound	the lower bound value to set
lUpperBound	the upper bound value to set
pInDefiningElement	the Fib-element which defines/ uses the new vector

fib::cVectorArea::cVectorArea	(	longFib	lLowerBound,
		cFibVariable *	pVariableUpperBound,
		cFibElement *	pInDefiningElement = `NULL`
	)

parameterconstructor

Parameters:

lLowerBound	the lower bound value to set
pVariableUpperBound	the upper bound variable to set
pInDefiningElement	the Fib-element which defines/ uses the new vector

fib::cVectorArea::cVectorArea	(	cFibVariable *	pVariableLowerBound,
		longFib	lUpperBound,
		cFibElement *	pInDefiningElement = `NULL`
	)

parameterconstructor

Parameters:

pVariableLowerBound	the lower bound variable to set
lUpperBound	the upper bound value to set
pInDefiningElement	the Fib-element which defines/ uses the new vector

fib::cVectorArea::cVectorArea	(	cFibVariable *	pVariableLowerBound,
		cFibVariable *	pVariableUpperBound,
		cFibElement *	pInDefiningElement = `NULL`
	)

parameterconstructor

Parameters:

pVariableLowerBound	the lower bound variable to set
pVariableUpperBound	the upper bound variable to set
pInDefiningElement	the Fib-element which defines/ uses the new vector

fib::cVectorArea::cVectorArea	(	const TiXmlElement *	pXmlElement,
		intFib &	outStatus,
		list< cFibVariable * > &	liDefinedVariables
	)

The constructor for restoring a vector from an TinyXml element.

Parameters:

pXmlNode	a pointer to the TinyXml node the vector 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 vector, every variable should have it's number (the number under which it is stored) as it's value

fib::cVectorArea::cVectorArea	(	cReadBits &	iBitStream,
		intFib &	outStatus,
		list< cFibVariable * > &	liDefinedVariables,
		const cDomain *	pInVectorDomain,
		const cDomain *	pInDomainVariable
	)

This constructor restores a subareasvector from the stream where it is stored in the compressed fib -format.

Parameters:

iBitStream	the stream where this vector 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 vector, every variable should have it's number (the number under which it is stored) as it's value
pInVectorDomain	the domain for this vector
pInDomainVariable	the domain for variables

Member Function Documentation

virtual cVectorArea* fib::cVectorArea::createInstance	(	unsignedIntFib	iNumberOfElements = `2`,
		cFibElement *	definingAreaElement = `NULL`
	)		const

virtual

This method creates an instance of this vector type.

Parameters:

iNumberOfElements	number of elements in the vector (this will be ignored for the subareavector)
definingAreaElement	the Fib-areaelement which defines/ uses the subareasvector

Implements fib::cFibVector.

list<longFib> fib::cVectorArea::getAreaValues ( ) const

Returns:: all values which are in the subarea

virtual cDomainVectorBasis* fib::cVectorArea::getDomain ( ) const

virtual

Returns a reference to the domain of the vector or the nullpointer NULL if no domain is defined for the vector. If the nullpointer NULL is returned the standarddomain is valid for the vector.

Returns:: a reference to the vectordomain of the vector

Reimplemented from fib::cFibVector.

virtual cTypeElement* fib::cVectorArea::getElementType ( ) const

virtual

Returns the type of the vector. You have to delete the returned object after usage.

Returns:: the type of the vector

Implements fib::cFibVector.

longFib fib::cVectorArea::getLowerBound ( ) const

Returns:: the lower bound of the subarea

virtual cDomainVectorBasis* fib::cVectorArea::getStandardDomain ( ) const

virtual

Returns a reference to the standard domain of the vector. You have to delete the returned object after usage.

Returns:: a reference to the standard domain of the vector

Reimplemented from fib::cFibVector.

longFib fib::cVectorArea::getUpperBound ( ) const

Returns:: the upper bound of the subarea

virtual cDomainVectorBasis* fib::cVectorArea::getValueDomain ( ) const

virtual

Returns a reference to the value domain of the vector or the nullpointer NULL if no value domain is defined for the vector. If the nullpointer NULL is returned the standarddomain is valid for the vector.

Returns:: a reference to the definitionarea of the vector

Reimplemented from fib::cFibVector.

virtual string fib::cVectorArea::getVectorType ( ) const

virtual

Returns:: the name for the type of the vector

Implements fib::cFibVector.

virtual cVectorArea& fib::cVectorArea::operator= ( const cFibVector & vector )

virtual

This Method makes this vectorelements equal to the correspondending vectorelements of the given vector. The type of the vector and the number of elements won't be changed.

Parameters:

vector the vector to copy

Reimplemented from fib::cFibVector.

virtual void fib::cVectorArea::setDefiningFibElement	(	cFibElement *	fibElement = `NULL`,
		bool	bCheckDomains = `true`
	)

virtual

Sets the Fib-element which defines/ uses this vector. If the given pointer is the nullpointer (standardvalue), no Fib-element defines this vector.

Parameters:

pInDefiningElement	a pointer to the Fib-element which defines/ uses this vector
bCheckDomains	getthe domains of the defining element and check the vectorelements with it

Reimplemented from fib::cFibVector.

bool fib::cVectorArea::setLowerBoundValue ( longFib lValue )

This method sets the lower bound of the subarea to the given value.

Parameters:

lValue the lower bound to set

Returns:: true if the lower bound is set to the given value lValue, else false

bool fib::cVectorArea::setLowerBoundVariable ( cFibVariable * pVariable )

This method sets the lower bound of the subarea to the given variable.

Parameters:

pVariable the lower bound variable to set

Returns:: true if the lower bound is set to the given variable pVariable, else false

bool fib::cVectorArea::setUpperBoundValue ( longFib lValue )

This method sets the upper bound of the subarea to the given value.

Parameters:

lValue the upper bound to set

Returns:: true if the upper bound is set to the given value lValue, else false

bool fib::cVectorArea::setUpperBoundVariable ( cFibVariable * pVariable )

This method sets the upper bound of the subarea to the given variable.

Parameters:

pVariable the upper bound variable to set

Returns:: true if the upper bound is set to the given variable pVariable, else false

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

fib/incl/cVectorArea.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation