Coral::DecoderInterface Class Reference

Decoder Interface. More...

#include <decoderinterface.h>

Inheritance diagram for Coral::DecoderInterface:

List of all members.

Public Member Functions
virtual	~DecoderInterface ()
virtual const card16	getTypeID () const =0
virtual const char *	getTypeName () const =0
virtual void	activate ()=0
virtual void	deactivate ()=0
virtual void	reset ()=0
virtual bool	checkNextPacket (DecoderPacket *packet)=0
virtual void	handleNextPacket (const DecoderPacket *decoderPacket)=0
virtual void	getMediaInfo (MediaInfo &mediaInfo) const =0
virtual card8	getErrorCode () const =0
virtual card64	getPosition () const =0
virtual card64	getMaxPosition () const =0

---

Detailed Description

Decoder Interface.

This class is the interface for a decoder.

Author:

Thomas Dreibholz

Version:

1.0

---

Constructor & Destructor Documentation

Coral::DecoderInterface::~DecoderInterface

(

)

[virtual]

Virtual destructor.

---

Member Function Documentation

virtual void Coral::DecoderInterface::activate

(

)

[pure virtual]

Activate the decoder. Usage example: Start an decoder thread.

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

virtual bool Coral::DecoderInterface::checkNextPacket

(

DecoderPacket *

packet

)

[pure virtual]

Check next packet. This function has to set valid packet->Layers and packet->Layer value.

Parameters:

decoderPacket

DecoderPacket structure.

Returns:

true, if packet is valid; false otherwise.

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

virtual void Coral::DecoderInterface::deactivate

(

)

[pure virtual]

Deactivate the decoder. Usage example: Stop an decoder thread.

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

virtual card8 Coral::DecoderInterface::getErrorCode

(

)

const [pure virtual]

Get error code Usage example: Return error, if reading from file failed.

Returns:

Error code

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

virtual card64 Coral::DecoderInterface::getMaxPosition

(

)

const [pure virtual]

Get maximum position in nanoseconds.

Returns:

Maximum position in nanoseconds.

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

virtual void Coral::DecoderInterface::getMediaInfo

(

MediaInfo &

mediaInfo

)

const [pure virtual]

Get media info.

Parameters:

mediaInfo

Reference to store MediaInfo to.

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

virtual card64 Coral::DecoderInterface::getPosition

(

)

const [pure virtual]

Get current position in nanoseconds.

Returns:

Position in nanoseconds.

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

virtual const card16 Coral::DecoderInterface::getTypeID

(

)

const [pure virtual]

Get the decoder's type ID.

Returns:

Decoder's type ID.

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

virtual const char* Coral::DecoderInterface::getTypeName

(

)

const [pure virtual]

Get the decoder's name.

Returns:

Decoder's name

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

virtual void Coral::DecoderInterface::handleNextPacket

(

const DecoderPacket *

decoderPacket

)

[pure virtual]

Handle next received packet.

Parameters:

decoderPacket

DecoderPacket structure.

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

virtual void Coral::DecoderInterface::reset

(

)

[pure virtual]

Reset the decoder. Usage example: Reset an decoder thread.

Implemented in Coral::TraceDecoderRepository, and Coral::TraceDecoder.

---

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

• decoderinterface.h
• decoderinterface.cc