#include <cCondition.h>
List of all members.
Static Public Member Functions |
static cCondition * | restoreXml (const TiXmlElement *pXmlElement, intFib &outStatus, list< cFibVariable * > &liDefinedVariables, cCondition *pInSuperiorCondition=NULL, cFibElement *pInDefiningFibElement=NULL) |
static cCondition * | restore (cReadBits &iBitStream, intFib &outStatus, list< cFibVariable * > &liDefinedVariables, const cDomainSingle *pInValueDomain, const cDomainSingle *pInDomainVariable, cCondition *pInSuperiorCondition=NULL, cFibElement *pInDefiningFibElement=NULL) |
Detailed Description
Definition at line 69 of file cCondition.h.
Constructor & Destructor Documentation
fib::cCondition::cCondition |
( |
cCondition * |
pInSuperiorCondition = NULL , |
|
|
cFibElement * |
pInDefiningFibElement = NULL |
|
) |
| |
|
protected |
The constructor of the condition.
- Parameters:
-
pInSuperiorCondition | the condition which contains |
pInDefiningFibElement | the Fib-element which defines/ uses the new condition |
The copy constructor of the condition.
- Parameters:
-
condition | the condition which to copy |
pSuperiorCondition | the condition which contains |
pInDefiningFibElement | the Fib-element which defines/ uses |
virtual fib::cCondition::~cCondition |
( |
| ) |
|
|
virtual |
The destructor of the condition.
Member Function Documentation
virtual bool fib::cCondition::equal |
( |
const cCondition & |
condition | ) |
const |
|
pure virtual |
virtual string fib::cCondition::getConditionName |
( |
| ) |
const |
|
pure virtual |
cFibElement* fib::cCondition::getDefiningFibElement |
( |
| ) |
const |
- Returns:
- the Fib-element which defines/ uses this condition or a Nullpointer NULL if non such Fib-element exists
virtual unsignedIntFib fib::cCondition::getNumberOfConditions |
( |
| ) |
const |
|
pure virtual |
virtual unsignedIntFib fib::cCondition::getNumberOfUnderFunctions |
( |
| ) |
const |
|
pure virtual |
cCondition* fib::cCondition::getSuperiorCondition |
( |
| ) |
const |
- Returns:
- the superior condition to this or NULL, if non such exists (the superior condition is the condition, which contains this condition)
This method evaluades a value for the time needed to evalue the condition. This value should not exceed lMaxTime, if the value for the time is greater than lMaxTime the evaluation will be stopt and lMaxTime returned. If lMaxTime is 0 (for infinity) the evaluation won't be stoped, this is the standard case.
- See also:
- cFibElement::evalueObject()
- Parameters:
-
lMaxTime | the maximum time for the evaluation, the returned exceed this value; the value 0 stands for infinity, so the evaluation won't be stoped |
- Returns:
- a value for the time needed to evalue this condition
Implemented in fib::cConditionComparison, fib::cConditionTwoValue, fib::cConditionNot, fib::cConditionFalse, and fib::cConditionTrue.
virtual set<cFibVariable*> fib::cCondition::getUsedVariables |
( |
| ) |
|
|
pure virtual |
virtual bool fib::cCondition::getValue |
( |
| ) |
const |
|
pure virtual |
virtual bool fib::cCondition::isUsedVariable |
( |
const cFibVariable * |
variable | ) |
const |
|
pure virtual |
virtual bool fib::cCondition::isValid |
( |
| ) |
const |
|
pure virtual |
bool fib::cCondition::operator!= |
( |
const cCondition & |
condition | ) |
const |
This method checks if the given condition is not equal to this condition.
- Parameters:
-
condition | the condition to compare with this condition |
- Returns:
- true if the given condition is not equal to this condition, else false
virtual bool fib::cCondition::operator== |
( |
const cCondition & |
condition | ) |
const |
|
virtual |
This method checks if the given condition is equal to this condition.
- Parameters:
-
condition | the condition to compare with this condition |
- Returns:
- true if the given condition is equal to this condition, else false
This method restores a condition from a bitstream, wher it is stored in the compressed Fib-format.
- See also:
- store
- Parameters:
-
iBitStream | the stream where the condition is stored in, because the stream is an cReadBits, any number of bits can be readed from it |
outStatus | an integervalue with the errorvalue 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 |
pInValueDomain | the domain for value condition |
pInDomainVariable | the domain for variables |
pInSuperiorCondition | the condition which contains the to restore condition |
pInDefiningFibElement | the Fib-element which defines/ uses the to restore condition |
- Returns:
- a pointer to the restored condition or NULL
This method restores a condition in the XML-format from an TinyXml element.
- Parameters:
-
pXmlNode | a pointer to the TinyXml node wher the condition is stored in |
outStatus | an integervalue with the errorvalue 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 |
pInSuperiorCondition | the condition which contains the to restore condition |
pInDefiningFibElement | the Fib-element which defines/ uses the to restore condition |
- Returns:
- the pointers to the restored condition, if non could be restored the returned pointer is NULL
virtual void fib::cCondition::setDefiningFibElement |
( |
cFibElement * |
fibElement = NULL , |
|
|
bool |
bCheckDomains = true |
|
) |
| |
|
virtual |
Sets the Fib-element which defines/ uses this condition. If the given pointer is the nullpointer (standardvalue), no Fib-element defines this condition.
- Parameters:
-
definingFibElement | a pointer to the Fib-element which defines/ uses this condition |
bCheckDomains | get the domains of the defining element and check the conditionelements with it |
Reimplemented in fib::cConditionComparison, fib::cConditionTwoValue, and fib::cConditionNot.
virtual bool fib::cCondition::store |
( |
ostream & |
stream, |
|
|
char & |
cRestBits, |
|
|
unsigned char & |
uiRestBitPosition |
|
) |
| const |
|
pure 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
Implemented in fib::cConditionComparison, fib::cConditionTwoValue, fib::cConditionNot, fib::cConditionFalse, and fib::cConditionTrue.
virtual bool fib::cCondition::storeXml |
( |
ostream & |
stream | ) |
const |
|
pure virtual |
Friends And Related Function Documentation
Member Data Documentation
the definitions for the condition
Definition at line 81 of file cCondition.h.
the Fib-element which defines/ uses the condition
Definition at line 101 of file cCondition.h.
the Fib-element which defines/ uses the condition
Definition at line 96 of file cCondition.h.
The documentation for this class was generated from the following file: