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

#include <cTypeExtObjectInput.h>

Inheritance diagram for fib::cTypeExtObjectInput:
Collaboration diagram for fib::cTypeExtObjectInput:

List of all members.

Public Member Functions

 cTypeExtObjectInput (const longFib lInExtObjectIdentifier)
 cTypeExtObjectInput (const cTypeExtObjectInput &typeExternObject)
virtual unsignedIntFib getType () const
virtual cDomaingetStandardDomain () const
virtual bool isCompatible (const cDomain &domain) const
virtual bool operator== (const cTypeElement &typeElement) const
virtual cTypeExtObjectInputclone () const
virtual unsignedLongFib getCompressedSize () const
virtual bool storeXml (ostream &ostream, const cDomain *domain=NULL) const
virtual cDomainrestoreXmlWithDomain (const TiXmlElement *pXmlElement, intFib &outStatus, const bool bRestoreDomain=true)
virtual bool store (ostream &stream, char &cRestBits, unsigned char &uiRestBitPosition) const
virtual intFib restore (cReadBits &iBitStream)
longFib getExtObjectIdentifier () const
- Public Member Functions inherited from fib::cTypeElement
virtual ~cTypeElement ()=0
virtual bool equalElementType (const cTypeElement &typeElement) const
virtual bool equal (const cTypeElement &typeElement) const
virtual bool isInherited () const

Private Attributes

longFib lExtObjectIdentifier

Additional Inherited Members

- Static Public Member Functions inherited from fib::cTypeElement
static cTypeElementrestoreXmlType (const TiXmlElement *pXmlElement, intFib &outStatus)
static pair< cTypeElement
*, cDomain * > 
restoreXmlTypeWithDomain (const TiXmlElement *pXmlElement, intFib &outStatus, const bool bRestoreDomain=true)
static cTypeElementrestore (cReadBits &iBitStream, intFib &outStatus)
- Static Protected Member Functions inherited from fib::cTypeElement
static bool isCounterDomain (const cDomain *pDomain)

Detailed Description

Definition at line 53 of file cTypeExtObjectInput.h.


Constructor & Destructor Documentation

fib::cTypeExtObjectInput::cTypeExtObjectInput ( const longFib  lInExtObjectIdentifier)

The constructor for external object input typs.

Parameters:
lInExtObjectIdentifierthe number of the external object input domain for which this type stands
fib::cTypeExtObjectInput::cTypeExtObjectInput ( const cTypeExtObjectInput typeExternObject)

The copyconstructor for external object input typs.

Parameters:
typeExternObjectthe type external object input to copy

Member Function Documentation

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

This method clones this object.

Returns:
a clone of this object

Implements fib::cTypeElement.

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

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.

longFib fib::cTypeExtObjectInput::getExtObjectIdentifier ( ) const
Returns:
the identifier of the external object for which this type stands
See also:
lExtObjectIdentifier
virtual cDomain* fib::cTypeExtObjectInput::getStandardDomain ( ) const
virtual

This method returns a pointer to a new instance of the standard domain for elements of this external object input type. You have to delete the returned object after usage.

Returns:
the standard domain for elements of this type

Reimplemented from fib::cTypeElement.

virtual unsignedIntFib fib::cTypeExtObjectInput::getType ( ) const
virtual

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::cTypeExtObjectInput::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:
domainthe domain, which should be compatible
Returns:
true if the given domain is compatible, else false

Reimplemented from fib::cTypeElement.

virtual bool fib::cTypeExtObjectInput::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.

virtual intFib fib::cTypeExtObjectInput::restore ( cReadBits iBitStream)
virtual

This method restores a type from a bitstream, wher it is stored in the compressed Fib format.

See also:
store
Parameters:
iBitStreamthe 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::cTypeExtObjectInput::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:
pXmlNodea pointer to the TinyXml node wher the type is stored in
outStatusan 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
bRestoreDomainif 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::cTypeExtObjectInput::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:
streamthe stream where this type element 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 the type element is stored, else false

Implements fib::cTypeElement.

virtual bool fib::cTypeExtObjectInput::storeXml ( ostream &  ostream,
const cDomain domain = NULL 
) const
virtual

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

Parameters:
ostreamthe stream where domains should be stored to
domainthe 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

longFib fib::cTypeExtObjectInput::lExtObjectIdentifier
private

The identifier of the external object for which this type stands.

Definition at line 58 of file cTypeExtObjectInput.h.


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