The Fib multimedia system
Fib is a system for storing multimedia data (like images or films).
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
fib::cArea Class Reference

#include <cArea.h>

Inheritance diagram for fib::cArea:
Collaboration diagram for fib::cArea:

List of all members.

Public Member Functions

 cArea (const cVectorArea &inVectorArea, cFibElement *pInSuperiorElement=NULL, cFibElement *pInPreviousFibElement=NULL, cFibElement *pInUnderobject=NULL)
 cArea (const cArea &areaElement)
virtual char getType () const
virtual bool evalueObject (iEvaluePosition &evaluePosition, const unsignedIntFib objectPoint, list< cVectorProperty > &liVecProperties) const
virtual bool evalueObject (iEvalueFibElement &evalueFibElement, const unsignedIntFib objectPoint, list< cVectorProperty > &liVecProperties, const list< char > &liCFibElementTyps)
virtual unsignedLongFib getTimeNeed (unsignedLongFib lMaxTime=0) const
virtual unsignedLongFib getCompressedSize () const
virtual bool isUsedVariable (const cFibVariable *variable, edDirection direction=ED_POSITION) const
virtual set< cFibVariable * > getUsedVariables (edDirection direction=ED_POSITION)
virtual bool replaceVariable (cFibVariable *variableOld, cFibVariable *variableNew)
virtual cFibElementcopyElement (const char cType='u', const unsignedIntFib elementPoint=0, bool bAbsolute=false) const
virtual bool equal (const cFibElement &fibObject) const
virtual bool equalElement (const cFibElement &fibElement) const
virtual bool storeXml (ostream &stream) const
unsignedIntFib getNumberOfSubareas () const
cVectorAreagetSubarea (unsignedIntFib iSubarea=1)
bool addSubarea (const cVectorArea &underArea, unsignedIntFib uiPosition=0)
bool deleteSubarea (unsignedIntFib uiSubareaPosition)
bool sort ()
cFibVariablegetDefinedVariable ()
- Public Member Functions inherited from fib::cFibLimb
virtual ~cFibLimb ()
virtual bool isValidFibElement () const
virtual unsignedIntFib getNumberOfElements (char cType='u') const
virtual unsignedIntFib getNumberOfMovePoints () const
virtual unsignedIntFib getNumberOfObjectPoints () const
virtual unsignedIntFib objectPointToElementPoint (const unsignedIntFib uiObjectPoint, bool bAbsolute=false) const
virtual bool insertElement (cFibElement *fibElement, const char cType='u', const unsignedIntFib elementPoint=0, bool bAbsolute=false, bool bCheckVariables=true)
virtual bool insertObjectInElement (cFibElement *fibObject, const char cType='u', const unsignedIntFib elementPoint=0, bool first=true, bool bAbsolute=false)
virtual bool overwriteObjectWithObject (cFibElement *fibObject, const char cType='u', const unsignedIntFib elementPoint=0, bool bDeleteOld=true, bool bAbsolute=false)
virtual bool removeObject (const unsignedIntFib objectPoint, bool bDeleteOld=true, bool bAbsolute=false)
virtual bool hasUnderAllObjects () const
virtual cFibElementcutElement (const char cType='u', const unsignedIntFib elementPoint=0, bool bAbsolute=false, bool bCheckVariables=true)
virtual bool isMovable () const
virtual intFib moveLimbElement (const char cType='u', const unsignedIntFib elementPoint=0, const intFib iHowfar=1, bool bAbsolute=false)
virtual bool isLimb () const
- Public Member Functions inherited from fib::cFibElement
virtual ~cFibElement ()
virtual cFibElementgetSuperiorFibElement ()
virtual cFibElementgetNextFibElement ()
virtual cFibElementgetNextFibElement (char cType)
virtual cFibElementgetConstFibElement (longFib lNumber, bool bAbsolute=false) const
virtual cFibElementgetConstFibElement (char cType, longFib lNumber, bool bAbsolute=false) const
cFibElementgetFibElement (longFib lNumber, bool bAbsolute=false)
cFibElementgetFibElement (char cType, longFib lNumber, bool bAbsolute=false)
list< cFibElement * > getAllFibElements (char cTypeBasis='u', longFib lNumber=1, char cType='u', edDirection direction=ED_ALL, unsignedLongFib lNumberOfMaxReturnedElements=0, bool bAbsolute=false)
bool evalueObjectSimple (iEvaluePosition &evaluePosition, const unsignedIntFib objectPoint=0) const
bool evalueObjectSimple (iEvalueFibElement &evalueFibElement, const unsignedIntFib objectPoint=0, const list< char > liCFibElementTyps=list< char >())
virtual bool isDefinedVariable (const cFibVariable *variable, edDirection direction=ED_POSITION) const
virtual list< cFibVariable * > getDefinedVariables (edDirection direction=ED_HIGHER)
bool variablesAreDefined (const set< cFibVariable * > &setVariable, edDirection direction=ED_HIGHER) const
virtual unsignedIntFib getNumberOfElement (bool bOfType=false) const
virtual unsignedIntFib getNumberOfMovePoint () const
virtual unsignedIntFib getNumberOfObjectPoint () const
virtual unsignedIntFib typeElementPointToElementPoint (const char cType, const unsignedIntFib elementPoint, bool bAbsolute=false) const
virtual list< unsignedIntFibelementPointToObjectPoints (const char cType, const unsignedIntFib elementPoint, bool bAbsolute=false) const
virtual list< unsignedIntFibgetObjectPointsForElement (const cFibElement *pFibElement, bool bAbsolute=false) const
virtual bool isRemovableElement (const char cType='u', const unsignedIntFib elementPoint=0, bool bAbsolute=false, bool bCheckVariables=true) const
virtual bool removeElement (const char cType='u', const unsignedIntFib elementPoint=0, bool bAbsolute=false, bool bCheckVariables=true)
virtual cFibElementclone () const
virtual cFibElementcopy (const unsignedIntFib iObjectPoint=0) const
virtual bool equalValuesSet (const cFibVariable *variableOwn, const cFibElement &fibElement, const cFibVariable *variable) const
virtual bool store (ostream &stream) const
virtual cRootgetSuperiorRootElement ()
virtual const cRootgetSuperiorRootElement () const
virtual list< longFibgetAllRootObjectIdentifiers () const
virtual list< longFibgetAllDatabaseObjectIdentifiers () const
virtual cRootgetRootObject (longFib lIdentifier)
virtual list< longFibgetAllAccessibleRootObjectIdentifiers () const
virtual cRootgetAccessibleRootObject (longFib lIdentifier)
virtual cDomains getValidDomains () const
virtual cDomains getValidValueDomains () const
virtual unsignedIntFib getNumberOfDimensions () const
virtual unsignedIntFib getDimensionMapping (unsignedIntFib iDimensionNumber) const
virtual bool isBranch () const
virtual bool isLeaf () const

Protected Member Functions

 cArea (const TiXmlElement *pXmlElement, intFib &outStatus, list< cFibVariable * > &liDefinedVariables)
 cArea (cReadBits &iBitStream, intFib &outStatus, list< cFibVariable * > &liDefinedVariables, const cDomains &validDomains, cRoot *pNextRoot)
virtual bool storeBit (ostream &stream, char &cRestBits, unsigned char &uiRestBitPosition) const
virtual unsignedIntFib enumerateVariablesForStoring (unsignedIntFib uiLastVariableNumber=0)
virtual cFibElementcopyInternal (const unsignedIntFib iObjectPoint=0) const
virtual bool isDefinedVariableInternal (const cFibVariable *pVariable, edDirection direction=ED_POSITION, const cFibElement *pCallingFibElement=NULL) const
virtual list< cFibVariable * > getDefinedVariablesInternal (edDirection direction=ED_HIGHER, const cFibElement *pCallingFibElement=NULL)
- Protected Member Functions inherited from fib::cFibLimb
 cFibLimb (cFibElement *pInSuperiorElement=NULL, cFibElement *pInPreviousFibElement=NULL, cFibElement *pInUnderobject=NULL)
 cFibLimb (const cFibLimb &fibLimbElement)
virtual bool registerNewFibElement (cFibElement *newFibElement, unsignedIntFib uINumberOfFibElement, bool bDirectionUp)
virtual bool registerNewFibObject (cFibElement *newFibObject, unsignedIntFib uILowerNumberOfFibElements, unsignedIntFib uIUpperNumberOfFibElements, bool bDirectionUp)
virtual void cutConnections (edDirection direction=ED_ALL)
virtual cFibElementupdateValues (cFibElement *previosFibElement=NULL, cFibElement *pNextArm=NULL)
virtual list< cFibElement * > getAllFibElementsFromPosition (char cType, edDirection direction, unsignedLongFib lNumberOfMaxReturnedElements)
- Protected Member Functions inherited from fib::cFibElement
 cFibElement (cFibElement *pInSuperiorElement=NULL, cFibElement *pInPreviousFibElement=NULL, cFibElement *pInNextFibElement=NULL)
 cFibElement (const cFibElement &fibElement)
virtual bool updateAllValues ()
virtual unsignedIntFib getNumberOfObjectPoint (unsignedIntFib uINumberOfStartFibElement) const
virtual list< unsignedIntFibelementPointToObjectPoints (const cFibElement *referencefibObject, const unsignedIntFib uiLastObjectPoint) const
intFib moveLimbElementUp (const char cType= 'u', const unsignedIntFib elementPoint=0, const unsignedIntFib uiHowfar=1, bool bAbsolute=false)
cFibElementgetMasterRoot ()
cFibElementgetMasterRoot () const

Private Attributes

list< cVectorArealiSubAreas
cFibVariable variableDefined

Friends

class cFibElement

Additional Inherited Members

- Protected Attributes inherited from fib::cFibLimb
cFibElementpUnderObject
- Protected Attributes inherited from fib::cFibElement
cFibElementpSuperiorElement
cFibElementpPreviousFibElement
cFibElementpNextFibElement
cRootpNextRootElement
unsignedIntFib uINumberOfFibElement

Detailed Description

Definition at line 60 of file cArea.h.


Constructor & Destructor Documentation

fib::cArea::cArea ( const cVectorArea inVectorArea,
cFibElement pInSuperiorElement = NULL,
cFibElement pInPreviousFibElement = NULL,
cFibElement pInUnderobject = NULL 
)

parameterconstructor

Parameters:
inVectorAreathe subareavector this area should have
pInSuperiorElementthe fib -element in which this area -element is an underobject
pInPreviousFibElementthe fib -element, which stands in the order of fib -elements befor this fib -element
pInUnderobjectthe fib -element which is the underobject of this fib -element (it also stands next in the order of fib -elements)
fib::cArea::cArea ( const cArea areaElement)

copyconstructor This copyconstructor constructs a copy of the given areaelement. It dosn't copy other area -elements than the given, even if ther are in the area -element.

Parameters:
areaElementthe area -element to copy
fib::cArea::cArea ( const TiXmlElement *  pXmlElement,
intFib outStatus,
list< cFibVariable * > &  liDefinedVariables 
)
protected

The constructor for restoring a areaobject from an TinyXml element.

Parameters:
pXmlNodea pointer to the TinyXml node wher the fib -object is stored in
outStatusAn 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
liDefinedVariablesa 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
fib::cArea::cArea ( cReadBits iBitStream,
intFib outStatus,
list< cFibVariable * > &  liDefinedVariables,
const cDomains validDomains,
cRoot pNextRoot 
)
protected

This constructor restores a areaobject from the stream where it is stored in the compressed fib -format. This method is for internal use only.

Parameters:
iBitStreamthe stream wher the areaobject is stored to in, because this stream is an cReadBits, any number of bits can be readed from it
outStatusAn 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
liDefinedVariablesa 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
validDomainsthe domains valid for restoring the fib -elements
pNextRootthe next higher root -element for the to restore fib -elements, or the last restored root -element

Member Function Documentation

bool fib::cArea::addSubarea ( const cVectorArea underArea,
unsignedIntFib  uiPosition = 0 
)

This method adds the given subarea to the existing subareas.

Parameters:
underAreaa reference to the to add subarea
uiPositionthe position wher the underArea should be added (counting begins with 1); if 0 the underArea will be added to the end of the subarea list
Returns:
true if the underArea was added, else false
virtual cFibElement* fib::cArea::copyElement ( const char  cType = 'u',
const unsignedIntFib  elementPoint = 0,
bool  bAbsolute = false 
) const
virtual

This method copies the fib -element on the specified position. Variables which are not defined in the fib -element but used don't change ther reference.

See also:
getType()
Parameters:
cTypethe type of the fib -element to copy
elementPointthe number of the fib -element, in the order of Fib -elements of the given type cType, to copy
bAbsoluteif the lNumber is an absolute value for the wool fib -object
Returns:
the copy of the fib -element

Implements fib::cFibElement.

virtual cFibElement* fib::cArea::copyInternal ( const unsignedIntFib  iObjectPoint = 0) const
protectedvirtual

This method copies the connected object with the given number in the order of connected objects. For this every fib -element, beginning from this fib -element, that is part of the connected object will be copied. Variables which are not defined in the connected object but used don't change ther reference. It is an helpmethod for the copy method. It dosn't update the structural information of the created fib -object.

Parameters:
iObjectPointthe number of the connected object to copy; the standartvalue is 0 for coping the complet actual object
Returns:
the copy of the connected object or NULL if non such exists

Implements fib::cFibElement.

bool fib::cArea::deleteSubarea ( unsignedIntFib  uiSubareaPosition)

This method deletes the uiSubareaPosition'th subarea from the existing subareas.

Parameters:
uiSubareaPositionthe position wher the underArea should be deleted (counting begins with 1)
Returns:
true if the subarea was deleted, else false
virtual unsignedIntFib fib::cArea::enumerateVariablesForStoring ( unsignedIntFib  uiLastVariableNumber = 0)
protectedvirtual

This method sets the each variable, which is defined over an leaf, to an uniqe integer number greater than the given number uiLastVariableNumber. While storing this number can be stored to identify the variable.

Parameters:
uiLastVariableNumberthe number which was last use, this means also is the greatest used, in this limb.
Returns:
the number which was last use, this means also is the greatest used, in this limb from the method

Reimplemented from fib::cFibLimb.

virtual bool fib::cArea::equal ( const cFibElement fibObject) const
virtual

This method checks if the given Fib -object is equal to this Fib -object. Variables can be others, but must be defined and used in equivalent fib -elements.

Parameters:
fibObjectthe Fib -object to which this Fib -object should be equal
Returns:
true if this Fib -object is equal to the given Fib -object, else false

Reimplemented from fib::cFibLimb.

virtual bool fib::cArea::equalElement ( const cFibElement fibElement) const
virtual

This method checks if the given fib -element is equal to this fib -element. The underobjects arn't compared, not even ther count is compared. Used variables can be others.

Parameters:
fibElementthe fib -element to which this fib -element should be equal
Returns:
true if this fib -element is equal to the given fib -object, else false

Implements fib::cFibElement.

virtual bool fib::cArea::evalueObject ( iEvaluePosition evaluePosition,
const unsignedIntFib  objectPoint,
list< cVectorProperty > &  liVecProperties 
) const
virtual

This method evaluades the fib -object.

Parameters:
evaluePositiona reference to the object with the evaluePosition() method to evalue /store the positions and ther properties; everytime a point (to evalue) is reached in the evaluation, this method is called with the position and the properties of the point;
See also:
iEvaluePosition
Parameters:
objectPointthe object point in the order of true partobjects to evalue
liVecPropertiesa list with the property vectors which should be global for the evalued object
Returns:
if the evalueation was successfull true, else false

Implements fib::cFibElement.

virtual bool fib::cArea::evalueObject ( iEvalueFibElement evalueFibElement,
const unsignedIntFib  objectPoint,
list< cVectorProperty > &  liVecProperties,
const list< char > &  liCFibElementTyps 
)
virtual

This method evaluades the fib -object. Evertime a fib -elements, with a type of the given type chars in liCFibElementTyps, is reached while evaluation, it is given back with the properties which it has. Ever pointelement is given back. The type chars for pointelements don't need to be in the list liCFibElementTyps.

Parameters:
evalueFibElementa reference to the object with the evalueElement() method to evalue /store the fib -elements and ther properties; everytime a fib -element (with one of the type given in liCFibElementTyps) is reached in the evaluation, the method evalueElement() of this objects is called with the fib -element and the properties of the fib -element;
See also:
iEvalueFibElement
Parameters:
objectPointthe object point in the order of true partobjects to evalue
liVecPropertiesa list with the property vectors which should be global for the evalued object
liCFibElementTypsa list with the type chars (
See also:
getType) of the fib -elements to return
Returns:
if the evalueation was successfull true, else false

Implements fib::cFibElement.

virtual unsignedLongFib fib::cArea::getCompressedSize ( ) const
virtual

This method evaluades the size of the Fib -object in bits in the compressed file form. The optionalpart field of area -elements will be ignored.

See also:
store()
Returns:
the size of the Fib -object in bits in the compressed form

Implements fib::cFibElement.

cFibVariable* fib::cArea::getDefinedVariable ( )
Returns:
a pointer to the variable this areaelement defines
virtual list< cFibVariable* > fib::cArea::getDefinedVariablesInternal ( edDirection  direction = ED_HIGHER,
const cFibElement pCallingFibElement = NULL 
)
protectedvirtual

This method returns all variables defined in the given direction from this Fib-element. This is for intern use to get the correct data from getDefinedVariables() without pCallingFibElement..

See also:
cFibVariable
getUsedVariables()
isDefinedVariable()
Parameters:
directionthe direction from this Fib-element, in which the variable should be used; standardvalue is ED_POSITION so yust this Fib-element will be checked
pCallingFibElementthe Fib-Element which called this method
Returns:
the set with all variables used in the given direction from this Fib-element

Reimplemented from fib::cFibLimb.

unsignedIntFib fib::cArea::getNumberOfSubareas ( ) const
Returns:
the number of subareas this areaelement consists of
cVectorArea* fib::cArea::getSubarea ( unsignedIntFib  iSubarea = 1)

This method returns a pointer to the iSubarea'th subarea of this areaelement.

Parameters:
iSubareathe number of the subarea to return (counting begins with 1)
Returns:
a pointer to the iSubarea'th subarea, or NULL if non such exists
virtual unsignedLongFib fib::cArea::getTimeNeed ( unsignedLongFib  lMaxTime = 0) const
virtual

This method evaluades a value for the time needed to evalue the object. 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:
evalueObject()
Parameters:
lMaxTimethe 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 the object

Implements fib::cFibElement.

virtual char fib::cArea::getType ( ) const
virtual
See also:
getTypeName
Returns:
a character for the typ of the fib -element Types are:
  • u: element of unknown typ
  • p: point
  • l: listelement
    • y: property
    • c: comment
    • a: area
    • f: function
    • i: if -condition
    • o: extern object element
    • s: extern underobject element
    • r: root -element

Implements fib::cFibElement.

virtual set<cFibVariable*> fib::cArea::getUsedVariables ( edDirection  direction = ED_POSITION)
virtual

This method returns all variables used in the given direction from this fib -element.

See also:
cFibVariable
isUsedVariable()
isDefinedVariable()
Parameters:
directionthe direction from this fib -element, in which the variable should be used; standardvalue is ED_POSITION so yust this fib -element will be checked
Returns:
the set with all variables used in the given direction from this fib -element

Reimplemented from fib::cFibLimb.

virtual bool fib::cArea::isDefinedVariableInternal ( const cFibVariable pVariable,
edDirection  direction = ED_POSITION,
const cFibElement pCallingFibElement = NULL 
) const
protectedvirtual

This method checks if the given variable is defined in the given direction from this Fib-element. This is for intern use to get the correct data from isDefinedVariable() without pCallingFibElement.

See also:
cFibVariable
isUsedVariable()
Parameters:
pVariablethe variable to check if it is defined
directionthe direction from this Fib-element, in which the variable should be defined; standardvalue is ED_POSITION so yust this Fib-element will be checked
pCallingFibElementthe Fib-Element which called this method
Returns:
true if the variable is used, else false

Reimplemented from fib::cFibLimb.

virtual bool fib::cArea::isUsedVariable ( const cFibVariable variable,
edDirection  direction = ED_POSITION 
) const
virtual

This method checks if the given variable is used in the given direction from this fib -element.

See also:
cFibVariable
isDefinedVariable()
Parameters:
variablethe variable to check if it is used
directionthe direction from this fib -element, in which the variable should be used; standardvalue is ED_POSITION so yust this fib -element will be checked
Returns:
true if the variable is used, else false

Reimplemented from fib::cFibLimb.

virtual bool fib::cArea::replaceVariable ( cFibVariable variableOld,
cFibVariable variableNew 
)
virtual

This method replace the variable variableOld with the variable variableNew in the object.

See also:
cFibVariable
isUsedVariable()
isDefinedVariable()
Parameters:
variableOldthe variable to replace
variableNewthe variable with which the variable variableOld is to replace
Returns:
true if the variable variableOld is replaced with variableNew, else false

Reimplemented from fib::cFibLimb.

bool fib::cArea::sort ( )

This method sorts the subareas.

when sorted the subarealist will fullfill the following constrains:

  • if the a suarea as two values as it's bounderies, the first value will be lower than the second
  • every subareas which have overlaped will be combined to one new subarea
  • the subarealist will be sorted in increasing order; subarea with lower bounderies will be on the front of the subarealist While sorting bounderies which are given by variables will be ignored.
Returns:
true if the subareas are sorted, else false
virtual bool fib::cArea::storeBit ( ostream &  stream,
char &  cRestBits,
unsigned char &  uiRestBitPosition 
) const
protectedvirtual

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. Beware: You need to call storeBit() of the root -elements with the domain for the area or the area will not be readebel.

See also:
store
Parameters:
streamthe stream where this Fib -object should be stored to
cRestBitsthe not yet writen bits which should be stored
uiRestBitPositionthe 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::cFibElement.

virtual bool fib::cArea::storeXml ( ostream &  stream) const
virtual

This method stores this Fib -object in the XML -format into the given stream.

Parameters:
streamthe stream where this Fib -object should be stored to
Returns:
true if this Fib -object is stored, else false

Implements fib::cFibElement.


Friends And Related Function Documentation

friend class cFibElement
friend

Definition at line 62 of file cArea.h.


Member Data Documentation

list<cVectorArea> fib::cArea::liSubAreas
private

The list with the subareas of the area element.

Definition at line 69 of file cArea.h.

cFibVariable fib::cArea::variableDefined
private

*The variable which this areaelement defines.

Definition at line 74 of file cArea.h.


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