#include <cTypeProperty.h>
List of all members.
Detailed Description
Definition at line 61 of file cTypeProperty.h.
Constructor & Destructor Documentation
The constructor for dimension typs.
- Parameters:
-
| iPropertyType | the number of the property this type represents; possible values are: TODO |
| iPropertyType | the number of dimension this property type is for; you don't have to give them if the number of dimensions is irrelevant for the property type |
| fib::cTypeProperty::cTypeProperty |
( |
const cTypeProperty & |
typeProperty | ) |
|
The copyconstructor for property typs.
- Parameters:
-
| typeProperty | the type property to copy |
The constructor for property typs. This constructor constructs a propertytype, which is of the same type as the given propertytype typeProperty, but which is adapted to the given domain if possible. For that the number of dimension is set to a value that is compatible to the vectordomain if possible. (If not possible number of dimension is set to the value as in typeProperty.)
- Parameters:
-
| typeProperty | the type property to copy |
| domain | the domain to which the propertytype is to be adapted |
Member Function Documentation
This Method clones this object.
- Returns:
- a clone of this object
Implements fib::cTypeElement.
This method evaluades the size of the typeelement in bits in the compressed file form.
- See also:
- store()
- Returns:
- the size of the typeelement in bits in the compressed form
Implements fib::cTypeElement.
| virtual string fib::cTypeProperty::getNameOfProperty |
( |
| ) |
const |
|
virtual |
| static unsignedIntFib fib::cTypeProperty::getNumberForPropertyName |
( |
const string |
szPropertyName | ) |
|
|
static |
- See also:
- getNameOfProperty()
- Parameters:
-
| szPropertyName | a name for a property |
- Returns:
- the number the name szPropertyName represents
| virtual unsignedIntFib fib::cTypeProperty::getNumberOfProperty |
( |
| ) |
const |
|
virtual |
- Returns:
- the type of property this type represents
| virtual list<cTypeProperty> fib::cTypeProperty::getOverwritenTyps |
( |
| ) |
const |
|
virtual |
- Returns:
- The typs of the properties the properties of this type overwrites
| virtual cDomain* fib::cTypeProperty::getStandardDomain |
( |
| ) |
const |
|
virtual |
This Method returns a pointer to a new instance of the standart domain for elements of this type. You have to delete the returned object after usage.
- Returns:
- the standart 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 vector<string> fib::cTypeProperty::getUnit |
( |
| ) |
const |
|
virtual |
- Returns:
- The SI unit for the dimension this type represents; possible values are:
- "": for none
- "m": for meter
- "s": for secound TODO
| virtual bool fib::cTypeProperty::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::cTypeProperty::isEvalued |
( |
| ) |
const |
|
virtual |
- Returns:
- this method returnes true, if the property of this type is for evaluating a fib -object, else false is returned
| static bool fib::cTypeProperty::isEvalued |
( |
const unsignedIntFib & |
uiTypeToCheck | ) |
|
|
static |
This function checks if the given type is evalued.
- Parameters:
-
| uiTypeToCheck | the number of the type to check, if it is evalued |
- Returns:
- this method returnes true, if the property of the given type is for evaluating a fib -object, else false is returned
| bool fib::cTypeProperty::isOverwritenTyp |
( |
const cTypeProperty & |
typeToCheck | ) |
const |
This method checks if the given type is overwritten by this type.
- Parameters:
-
| typeToCheck | the type to check, if it is overwritten |
- Returns:
- true if typeToCheck is overwritten by this type, else false
| bool fib::cTypeProperty::isOverwritenTyp |
( |
const unsignedIntFib & |
uiTypeToCheck | ) |
const |
This method checks if the given type is overwritten by this type.
- See also:
- uiPropertyType
- Parameters:
-
| uiTypeToCheck | the number of the type to check, if it is overwritten |
- Returns:
- true if uiTypeToCheck is overwritten by this type, else false
| bool fib::cTypeProperty::isOverwriting |
( |
| ) |
const |
- Returns:
- if this type overwrites typs true, else false
| static bool fib::cTypeProperty::isOverwriting |
( |
const unsignedIntFib & |
uiTypeToCheck | ) |
|
|
static |
This function checks if the given type overwrites some typs.
- Parameters:
-
| uiTypeToCheck | the number of the type to check, if it overwrittes other typs |
- Returns:
- if the given type overwrites typs true, else false
This function compares two cTypeProperty. Propertytype is lower, if it's number is lower than the number of the other Propertytype.
- Parameters:
-
| pTypeProperty1 | a pointer to the first propertytype to compare |
| pTypeProperty2 | a pointer to the second propertytype to compare |
- Returns:
- true if the propertytype pTypeProperty1 is lower than that of pTypeProperty2, else false
This function compares two cTypeProperty. Propertytype is lower, if it's number is lower than the number of the other Propertytype.
- Parameters:
-
| pTypeProperty1 | a pointer to the first propertytype to compare |
| pTypeProperty2 | a pointer to the second propertytype to compare |
- Returns:
- true if the propertytype pTypeProperty1 is lower than that of pTypeProperty2, else false
| virtual bool fib::cTypeProperty::operator< |
( |
const cTypeProperty & |
typeProperty | ) |
const |
|
virtual |
This function compares this property type with the given property type. Propertytype is lower, if it's number is lower than the number of the other Propertytype.
- Parameters:
-
| typeProperty | a pointer to the second propertytype to compare |
- Returns:
- true if this propertytype is lower than that the given of typeProperty, else false
| virtual bool fib::cTypeProperty::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::cTypeProperty::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::cTypeProperty::store |
( |
ostream & |
stream, |
|
|
char & |
cRestBits, |
|
|
unsigned char & |
uiRestBitPosition |
|
) |
| const |
|
virtual |
This method stores this typeelement 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 typeelement 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 typeelement is stored, else false
Implements fib::cTypeElement.
| virtual bool fib::cTypeProperty::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 dimension this property type is for. Some properties like soundPolarized change ther domains for different number of dimensions. So they need to be known, when the information about the domain of thes properties are given.
Definition at line 77 of file cTypeProperty.h.
the number of the dimension this type represents; possible values are: TODO
Definition at line 69 of file cTypeProperty.h.
The documentation for this class was generated from the following file:
Public Member Functions inherited from fib::cTypeElement
1.8.1 
