fib::cDomain Class Reference

#include <cDomain.h>

Inheritance diagram for fib::cDomain:

List of all members.

Public Member Functions
virtual	~cDomain ()=0
virtual string	getType () const =0
virtual bool	isScalar () const
virtual bool	isVector () const
virtual bool	isReference () const
virtual cDomain *	clone () const =0
virtual bool	equal (const cDomain &domain) const
virtual bool	operator== (const cDomain &domain) const
virtual unsignedIntFib	getCompressedSize () const =0
virtual bool	storeXml (ostream &ostream) const =0
virtual intFib	restoreXml (const TiXmlElement *pXmlElement)=0
virtual bool	store (ostream &stream, char &cRestBits, unsigned char &uiRestBitPosition) const =0
virtual intFib	restore (cReadBits &iBitStream)=0

Static Public Member Functions
static cDomain *	restoreXml (const TiXmlElement *pXmlElement, intFib &outStatus)
static cDomain *	restore (cReadBits &iBitStream, intFib &outStatus)

---

Detailed Description

Definition at line 59 of file cDomain.h.

---

Constructor & Destructor Documentation

virtual fib::cDomain::~cDomain ( )

pure virtual

destructor

---

Member Function Documentation

virtual cDomain* fib::cDomain::clone ( ) const

pure virtual

This Method clones this object.

Returns:

a clone of this object

Implemented in fib::cDomainInteger, fib::cDomainIntegerBit, fib::cDomainNaturalNumber, fib::cDomainNaturalNumberBit, fib::cDomainVectorOpenEnd, fib::cDomainVector, fib::cDomainRational, fib::cDomainIntegerBasis, fib::cDomainVectorBasis, fib::cDomainSingle, fib::cDomainReference, and fib::cDomainRationalBasis.

virtual bool fib::cDomain::equal ( const cDomain &  domain ) const

virtual

This Method checks if the given domain is equal to this domain.

Parameters:

domain

the domain which should be equal to this domain

Returns:

true if the given domain is equal to this domain, else false

virtual unsignedIntFib fib::cDomain::getCompressedSize ( ) const

pure virtual

This method evaluades the size of the domain in bits in the compressed file form.

See also:

store()

Returns:

the size of the domain in bits in the compressed form

Implemented in fib::cDomainInteger, fib::cDomainIntegerBit, fib::cDomainNaturalNumber, fib::cDomainNaturalNumberBit, fib::cDomainVectorOpenEnd, fib::cDomainVector, fib::cDomainRational, and fib::cDomainReference.

virtual string fib::cDomain::getType ( ) const

pure virtual

Returns:

the type of the domain as an string

Implemented in fib::cDomainInteger, fib::cDomainIntegerBit, fib::cDomainNaturalNumber, fib::cDomainReference, fib::cDomainNaturalNumberBit, fib::cDomainVectorOpenEnd, fib::cDomainVector, and fib::cDomainRational.

virtual bool fib::cDomain::isReference ( ) const

virtual

Returns:

true if the object represents a reference domain, else false

See also:

cDomainReference

Reimplemented in fib::cDomainReference.

virtual bool fib::cDomain::isScalar ( ) const

virtual

Returns:

true if the object represents a scalar domain, else false

Reimplemented in fib::cDomainSingle, and fib::cDomainVectorBasis.

virtual bool fib::cDomain::isVector ( ) const

virtual

Returns:

true if the object represents a vector domain, else false

Reimplemented in fib::cDomainSingle, and fib::cDomainVectorBasis.

virtual bool fib::cDomain::operator== ( const cDomain &  domain ) const

virtual

This Method checks if the given domain is equal to this domain.

Parameters:

domain

the domain which should be equal to this domain

Returns:

true if the given domain is equal to this domain, else false

Reimplemented in fib::cDomainInteger, fib::cDomainIntegerBit, fib::cDomainNaturalNumber, fib::cDomainNaturalNumberBit, fib::cDomainVectorOpenEnd, fib::cDomainVector, fib::cDomainReference, fib::cDomainRationalBasis, and fib::cDomainIntegerBasis.

static cDomain* fib::cDomain::restore ( cReadBits &  iBitStream, intFib &  outStatus  )

static

This method restores a domain from a bitstream, wher it is stored in the compressed fib -format.

Factory Method

See also:

store

Parameters:

iBitStream	the stream where the domain 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

Returns:

a pointer to the restored domain or NULL

virtual intFib fib::cDomain::restore ( cReadBits &  iBitStream )

pure virtual

This method restores a domain from a bitstream, wher it is stored in the compressed fib -format.

Factory Method

See also:

store

Parameters:

iBitStream

the stream where the domain is stored in, because the stream is an cReadBits, any number of bits can be readed from it

Returns:

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

Implemented in fib::cDomainInteger, fib::cDomainIntegerBit, fib::cDomainNaturalNumber, fib::cDomainNaturalNumberBit, fib::cDomainVectorOpenEnd, fib::cDomainVector, fib::cDomainRational, and fib::cDomainReference.

static cDomain* fib::cDomain::restoreXml ( const TiXmlElement *  pXmlElement, intFib &  outStatus  )

static

This method restores a domain in the XML -format from an TinyXml element.

Factory Method

Parameters:

pXmlNode	a pointer to the TinyXml node wher the domain 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

Returns:

the pointers to the restored domain, if non could be restored the returned pointer is NULL

virtual intFib fib::cDomain::restoreXml ( const TiXmlElement *  pXmlElement )

pure virtual

This method restores a domain in the XML -format from an TinyXml element.

Factory Method

Parameters:

pXmlNode

a pointer to the TinyXml node wher the domain is stored in

Returns:

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

Implemented in fib::cDomainInteger, fib::cDomainIntegerBit, fib::cDomainNaturalNumber, fib::cDomainNaturalNumberBit, fib::cDomainVectorOpenEnd, fib::cDomainVector, fib::cDomainRational, and fib::cDomainReference.

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

pure virtual

This method stores this domain in the compressed fib -format into the given stream. It is needed because 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:

cFibElement::store

Parameters:

stream	the stream where this domain 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 the domain is stored, else false

Implemented in fib::cDomainInteger, fib::cDomainIntegerBit, fib::cDomainNaturalNumber, fib::cDomainNaturalNumberBit, fib::cDomainVectorOpenEnd, fib::cDomainVector, fib::cDomainRational, and fib::cDomainReference.

virtual bool fib::cDomain::storeXml ( ostream &  ostream ) const

pure virtual

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

Parameters:

ostream

the stream where domains should be stored to

Returns:

true if this domain are stored, else false

Implemented in fib::cDomainInteger, fib::cDomainIntegerBit, fib::cDomainNaturalNumber, fib::cDomainNaturalNumberBit, fib::cDomainVectorOpenEnd, fib::cDomainVector, fib::cDomainRational, and fib::cDomainReference.

---

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

• fib/incl/cDomain.h