SDIF::Collection Class Reference

A special Storage to store Frames in a linked list. More...

#include <SDIFCollection.hxx>

List of all members.

Public Types
typedef std::list< Stream * > ::const_iterator	StreamIterator
Public Member Functions
	Collection (bool autoStreamAdding=true)
virtual	~Collection ()
void	Add (Frame *pFrame)
	virtual function that where derived classes get the frames read by the File.
void	Add (Stream *pStream)
FrameIterator	Begin (void) const
FrameIterator	End (void) const
StreamIterator	BeginStreams (void) const
StreamIterator	EndStreams (void) const
Stream *	FindStream (CLAM::TInt32 streamId)
Stream *	FindStream (TypeId streamTypeId)
void	ParseStreams (void)

---

Detailed Description

A special Storage to store Frames in a linked list.

The Collection has the possibility to create the Streams to which the frames belong, either on the fly, or on command

Typically, Collection is passed to File::Read, as the place the store the read Frames.

See also:

File::Read

Definition at line 42 of file SDIFCollection.hxx.

---

Member Typedef Documentation

typedef std::list<Stream*>::const_iterator SDIF::Collection::StreamIterator

Definition at line 45 of file SDIFCollection.hxx.

---

Constructor & Destructor Documentation

SDIF::Collection::Collection

(

bool

autoStreamAdding = true

)

Definition at line 28 of file SDIFCollection.cxx.

virtual SDIF::Collection::~Collection

(

)

[inline, virtual]

Definition at line 59 of file SDIFCollection.hxx.

---

Member Function Documentation

void SDIF::Collection::Add

(

Stream *

pStream

)

Definition at line 51 of file SDIFCollection.cxx.

void SDIF::Collection::Add

(

Frame *

pFrame

)

[virtual]

virtual function that where derived classes get the frames read by the File.

Note that the derived class is responsible for handling the memory deallocation of the frames it gets passed.

Implements SDIF::Storage.

Definition at line 33 of file SDIFCollection.cxx.

FrameIterator SDIF::Collection::Begin

(

void

)

const [inline, virtual]

Implements SDIF::Storage.

Definition at line 64 of file SDIFCollection.hxx.

StreamIterator SDIF::Collection::BeginStreams

(

void

)

const [inline]

Definition at line 67 of file SDIFCollection.hxx.

FrameIterator SDIF::Collection::End

(

void

)

const [inline, virtual]

Implements SDIF::Storage.

Definition at line 65 of file SDIFCollection.hxx.

StreamIterator SDIF::Collection::EndStreams

(

void

)

const [inline]

Definition at line 68 of file SDIFCollection.hxx.

Stream * SDIF::Collection::FindStream

(

TypeId

streamTypeId

)

Definition at line 98 of file SDIFCollection.cxx.

Stream * SDIF::Collection::FindStream

(

CLAM::TInt32

streamId

)

Definition at line 80 of file SDIFCollection.cxx.

void SDIF::Collection::ParseStreams

(

void

)

Definition at line 56 of file SDIFCollection.cxx.

---

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

• SDIFCollection.hxx
• SDIFCollection.cxx