#include <cTypeFibSet.h>
List of all members.
Detailed Description
Definition at line 53 of file cTypeFibSet.h.
Constructor & Destructor Documentation
fib::cTypeFibSet::cTypeFibSet |
( |
const unsignedIntFib |
uiInNumberOfDomain = 0 | ) |
|
The constructor for set-element typs.
- Parameters:
-
uiInNumberOfDomain | the number of the set-element domain for which this type stands |
fib::cTypeFibSet::cTypeFibSet |
( |
const cTypeFibSet & |
typeExternObject | ) |
|
The copyconstructor for set-element typs.
- Parameters:
-
typeExternObject | the type set-element to copy |
Member Function Documentation
This method clones this object.
- Returns:
- a clone of this object
Implements fib::cTypeElement.
This method evaluades the size of the type element in bits in the compressed file form.
- See also:
- store()
- Returns:
- the size of the type element in bits in the compressed form
Implements fib::cTypeElement.
- Returns:
- the number of the domain for which this type stands
- See also:
- uiNumberOfDomain
virtual cDomain* fib::cTypeFibSet::getStandardDomain |
( |
| ) |
const |
|
virtual |
This method returns a pointer to a new instance of the standard domain for elements of this set-element type. You have to delete the returned object after usage.
- Returns:
- the standard domain for elements of this type
Reimplemented from fib::cTypeElement.
This Function returns for the type of the element an number. The values, which are returned, mean:
- Returns:
- for the type of the element an number
Implements fib::cTypeElement.
virtual bool fib::cTypeFibSet::isCompatible |
( |
const cDomain & |
domain | ) |
const |
|
virtual |
This method checks, if this element type is compatible with the given domain. Just domains which are compadible can be used for the elements of this type.
- Parameters:
-
domain | the domain, which should be compatible |
- Returns:
- true if the given domain is compatible, else false
Reimplemented from fib::cTypeElement.
virtual bool fib::cTypeFibSet::operator== |
( |
const cTypeElement & |
typeElement | ) |
const |
|
virtual |
This method checks if the given type is equal to this type.
- Returns:
- true if the given type is equal to this type, else false
Reimplemented from fib::cTypeElement.
This method restores a type from a bitstream, wher it is stored in the compressed Fib format.
- See also:
- store
- Parameters:
-
iBitStream | the stream where the type 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
Implements fib::cTypeElement.
virtual cDomain* fib::cTypeFibSet::restoreXmlWithDomain |
( |
const TiXmlElement * |
pXmlElement, |
|
|
intFib & |
outStatus, |
|
|
const bool |
bRestoreDomain = true |
|
) |
| |
|
virtual |
This method restores a type with a domain in the XML -format from an TinyXml element.
- Parameters:
-
pXmlNode | a pointer to the TinyXml node wher the type is stored in |
outStatus | an integer value 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
|
bRestoreDomain | if true a domain is to be asumed in the type element and it will be restored, else no domain will be restores |
- Returns:
- a pointer to the restored domain, or NULL if it couldn't be restored
Implements fib::cTypeElement.
virtual bool fib::cTypeFibSet::store |
( |
ostream & |
stream, |
|
|
char & |
cRestBits, |
|
|
unsigned char & |
uiRestBitPosition |
|
) |
| const |
|
virtual |
This method stores this type element 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 type element 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 type element is stored, else false
Implements fib::cTypeElement.
virtual bool fib::cTypeFibSet::storeXml |
( |
ostream & |
ostream, |
|
|
const cDomain * |
domain = NULL |
|
) |
| const |
|
virtual |
This method stores this type in the XML-format into the given stream.
- Parameters:
-
ostream | the stream where domains should be stored to |
domain | the domain which should be stored to this type; if a Nullpointer NULL (the standardvalue) is given, no domain will be stored to this type |
- Returns:
- true if this type are stored, else false
Implements fib::cTypeElement.
Member Data Documentation
The number of the set-element domain for which this type stands.
Definition at line 58 of file cTypeFibSet.h.
The documentation for this class was generated from the following file: