Strigi::StreamThroughAnalyzer Class Reference

This class defines an interface for analyzing streams. More...

#include <streamthroughanalyzer.h>

Inheritance diagram for Strigi::StreamThroughAnalyzer:

[legend]

List of all members.

Public Member Functions
virtual	~StreamThroughAnalyzer ()
virtual InputStream *	connectInputStream (InputStream *in)=0
virtual bool	isReadyWithStream ()=0
virtual const char *	name () const =0
virtual void	setIndexable (Strigi::AnalysisResult *)=0

---

Detailed Description

This class defines an interface for analyzing streams.

This interface is not yet complete, it lacks good functions for retrieving the results in other ways than just printing them.

Definition at line 36 of file streamthroughanalyzer.h.

---

Constructor & Destructor Documentation

virtual Strigi::StreamThroughAnalyzer::~StreamThroughAnalyzer

(

)

[inline, virtual]

Definition at line 38 of file streamthroughanalyzer.h.

---

Member Function Documentation

virtual InputStream* Strigi::StreamThroughAnalyzer::connectInputStream

(

InputStream *

in

)

[pure virtual]

This function sets up the analyzer for handling a stream.

The stream in is used in constructing a new internal inputstream that is returned by this function. Every time a read call is performed on this class, the data read is used in the analysis before being passed on to the caller. The InputStream pointer maybe 0 for special filetypes that have no content, so any implementation must always check the pointer before reading from the stream.

Implemented in ProgramThroughAnalyzer, ID3V2ThroughAnalyzer, OggThroughAnalyzer, AuThroughAnalyzer, DdsThroughAnalyzer, IcoThroughAnalyzer, PcxThroughAnalyzer, RgbThroughAnalyzer, SidThroughAnalyzer, TgaThroughAnalyzer, and XbmThroughAnalyzer.

virtual bool Strigi::StreamThroughAnalyzer::isReadyWithStream

(

)

[pure virtual]

Signals to the caller whether this analyzer is finished with the current stream.

Implemented in ID3V2ThroughAnalyzer, OggThroughAnalyzer, AuThroughAnalyzer, DdsThroughAnalyzer, IcoThroughAnalyzer, PcxThroughAnalyzer, RgbThroughAnalyzer, SidThroughAnalyzer, TgaThroughAnalyzer, and XbmThroughAnalyzer.

virtual const char* Strigi::StreamThroughAnalyzer::name

(

)

const [pure virtual]

Return the name of this throughanalyzer.

Implemented in ID3V2ThroughAnalyzer, OggThroughAnalyzer, AuThroughAnalyzer, DdsThroughAnalyzer, IcoThroughAnalyzer, PcxThroughAnalyzer, RgbThroughAnalyzer, SidThroughAnalyzer, and XbmThroughAnalyzer.

virtual void Strigi::StreamThroughAnalyzer::setIndexable

(

Strigi::AnalysisResult *

)

[pure virtual]

Passes a pointer to the AnalysisResult to be used for this stream.

Implemented in ProgramThroughAnalyzer, ID3V2ThroughAnalyzer, OggThroughAnalyzer, AuThroughAnalyzer, DdsThroughAnalyzer, IcoThroughAnalyzer, PcxThroughAnalyzer, RgbThroughAnalyzer, SidThroughAnalyzer, TgaThroughAnalyzer, and XbmThroughAnalyzer.

---

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

• streamthroughanalyzer.h