MgzInputStream Class Reference

MgzInputStream is a wrapper class to read frames from .mgz files. More...

#include <Media/MgzInputStream.H>

Inheritance diagram for MgzInputStream:

[legend]

Collaboration diagram for MgzInputStream:

[legend]

List of all members.

Public Member Functions
	MgzInputStream (OptionManager &mgr, const std::string &descrName="Mgz Input Stream", const std::string &tagName="MgzInputStream")
	Construct an mgzstream object for mgz input.
virtual	~MgzInputStream ()
	Virtual destructor.
virtual void	setConfigInfo (const std::string &filename)
	Override from FrameIstream; just calls setFileName().
virtual GenericFrameSpec	peekFrameSpec ()
	get frame specifications, peeking at the first frame if necessary
void	setFileName (std::string fname)
	Configure the MGZ Stream for decoding.
virtual GenericFrame	readFrame ()
	Read the next frame from the mgz stream.

---

Detailed Description

MgzInputStream is a wrapper class to read frames from .mgz files.

mgz is a custom format that basically contains the raw frames in gzipped format. One mgz file can contain many frames of various sizes and types.

Definition at line 55 of file MgzInputStream.H.

---

Constructor & Destructor Documentation

MgzInputStream::MgzInputStream	(	OptionManager &	mgr,
		const std::string &	descrName = "Mgz Input Stream",
		const std::string &	tagName = "MgzInputStream"
	)

Construct an mgzstream object for mgz input.

Definition at line 55 of file MgzInputStream.C.

MgzInputStream::~MgzInputStream

(

)

[virtual]

Virtual destructor.

Definition at line 63 of file MgzInputStream.C.

---

Member Function Documentation

GenericFrameSpec MgzInputStream::peekFrameSpec

(

)

[virtual]

get frame specifications, peeking at the first frame if necessary

Implements FrameIstream.

Definition at line 79 of file MgzInputStream.C.

References GenericFrame::frameSpec(), GenericFrame::initialized(), and readFrame().

GenericFrame MgzInputStream::readFrame

(

)

[virtual]

Read the next frame from the mgz stream.

The native representation of the GenericFrame will be the same as what it was when the frame was stored into the stream.

Implements FrameIstream.

Definition at line 105 of file MgzInputStream.C.

References GenericFrame::initialized(), and MgzDecoder::readFrame().

Referenced by peekFrameSpec().

void MgzInputStream::setConfigInfo

(

const std::string &

filename

)

[virtual]

Override from FrameIstream; just calls setFileName().

Reimplemented from FrameIstream.

Definition at line 69 of file MgzInputStream.C.

References setFileName().

void MgzInputStream::setFileName

(

std::string

fname

)

Configure the MGZ Stream for decoding.

Parameters:

fname

name of file from which frames are to be read from

Definition at line 96 of file MgzInputStream.C.

Referenced by setConfigInfo().

---

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

• src/Media/MgzInputStream.H
• src/Media/MgzInputStream.C