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::cVectorPosition Class Reference

#include <cVectorPosition.h>

Inheritance diagram for fib::cVectorPosition:
Collaboration diagram for fib::cVectorPosition:

List of all members.

Public Member Functions

 cVectorPosition (cFibElement &definingPointElement)
 cVectorPosition (unsignedIntFib iNumberOfDimensions=2, cFibElement *pDefiningPointElement=NULL)
 cVectorPosition (const cVectorPosition &vector, cFibElement *definingFibElement=NULL)
 cVectorPosition (const TiXmlElement *pXmlElement, intFib &outStatus, list< cFibVariable * > &liDefinedVariables)
 cVectorPosition (cReadBits &iBitStream, intFib &outStatus, list< cFibVariable * > &liDefinedVariables, const cDomain *pInVectorDomain, const cDomain *pInDomainVariable)
virtual cVectorPositioncreateInstance (unsignedIntFib iNumberOfDimensions=2, cFibElement *definingPointElement=NULL) const
virtual void setDefiningFibElement (cFibElement *fibElement=NULL, bool bCheckDomains=true)
virtual cTypeElementgetElementType () const
virtual string getVectorType () const
- 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 cFibVariablegetVariable (unsignedIntFib iNumberElement)
virtual bool setVariable (unsignedIntFib iNumberElement, cFibVariable *pVariable)
virtual cDomainVectorBasisgetDomain () const
virtual cDomainVectorBasisgetValueDomain () const
virtual cDomaingetDomain (unsignedIntFib iNumberElement) const
virtual cDomainVectorBasisgetStandardDomain () const
virtual cDomainSinglegetVariableDomain () const
cFibElementgetDefiningFibElement () 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 cFibVectoroperator= (const cFibVector &vector)
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 cFibElementgetVariableUsingFibElement () const
virtual bool deleteVariable (cFibVariable *pVariable)
- Protected Attributes inherited from fib::cFibVector
vector< eVectorTypeliVectorType
vector< doubleFibliVectorValues
vector< cFibVariable * > liVectorVariable
cFibElementpDefiningFibElement

Detailed Description

Definition at line 52 of file cVectorPosition.h.


Constructor & Destructor Documentation

fib::cVectorPosition::cVectorPosition ( cFibElement definingPointElement)

The constructor of the positionvector.

Parameters:
definingPointElementthe Fib -pointelement which defines/ uses the positionsvector
fib::cVectorPosition::cVectorPosition ( unsignedIntFib  iNumberOfDimensions = 2,
cFibElement pDefiningPointElement = NULL 
)

The constructor of the positionvector.

Parameters:
iNumberOfDimensionsnumber of elements in the vector or the dimensions
pDefiningPointElementthe Fib -pointelement which defines/ uses the positionsvector
fib::cVectorPosition::cVectorPosition ( const cVectorPosition vector,
cFibElement definingFibElement = NULL 
)

The copy constructor of the vector.

Parameters:
vectorthe vector from which to copy the data
definingFibElementthe Fib -element which defines/ uses the new vector
fib::cVectorPosition::cVectorPosition ( const TiXmlElement *  pXmlElement,
intFib outStatus,
list< cFibVariable * > &  liDefinedVariables 
)

The constructor for restoring a vector from an TinyXml element.

Parameters:
pXmlNodea pointer to the TinyXml node the vector 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 vector, every variable should have it's number (the number under which it is stored) as it's value
fib::cVectorPosition::cVectorPosition ( cReadBits iBitStream,
intFib outStatus,
list< cFibVariable * > &  liDefinedVariables,
const cDomain pInVectorDomain,
const cDomain pInDomainVariable 
)

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

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

Member Function Documentation

virtual cVectorPosition* fib::cVectorPosition::createInstance ( unsignedIntFib  iNumberOfDimensions = 2,
cFibElement definingPointElement = NULL 
) const
virtual

This method creates an instance of this vector type.

Parameters:
iNumberOfDimensionsnumber of elements in the vector
definingPointElementthe Fib -pointelement which defines/ uses the positionsvector

Implements fib::cFibVector.

virtual cTypeElement* fib::cVectorPosition::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.

virtual string fib::cVectorPosition::getVectorType ( ) const
virtual
Returns:
the name for the type of the vector

Implements fib::cFibVector.

virtual void fib::cVectorPosition::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:
definingFibElementa pointer to the Fib -element which defines/ uses this vector
bCheckDomainsgetthe domains of the defining element and check the vectorelements with it

Reimplemented from fib::cFibVector.


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