SequenceFileStream Class Reference

Inheritance diagram for SequenceFileStream:

[legend]

Collaboration diagram for SequenceFileStream:

[legend]

List of all members.

Public Member Functions
	SequenceFileStream (OptionManager &mgr, const std::string &descrName="Sequence File Input Stream", const std::string &tagName="SeqquenceFileStream")
	Construct a Sequence File Stream object for .seq file input.
virtual	~SequenceFileStream ()
	Virtual destructor.
virtual void	setConfigInfo (const std::string &filename)
	Override from FrameIstream; just calls setFileName().
virtual bool	setFrameNumber (int n)
	Override from FrameIstream; sets the current frame number in the sequence.
virtual GenericFrameSpec	peekFrameSpec ()
	get frame specifications, peeking at the first frame if necessary
void	setFileName (const std::string &fname)
	Configure the MGZ Stream for decoding.
virtual GenericFrame	readFrame ()
	Read the next frame from the seq stream.

---

Detailed Description

Definition at line 47 of file SequenceFileStream.H.

---

Constructor & Destructor Documentation

SequenceFileStream::SequenceFileStream	(	OptionManager &	mgr,
		const std::string &	descrName = "Sequence File Input Stream",
		const std::string &	tagName = "SeqquenceFileStream"
	)

Construct a Sequence File Stream object for .seq file input.

Definition at line 59 of file SequenceFileStream.C.

SequenceFileStream::~SequenceFileStream

(

)

[virtual]

Virtual destructor.

Definition at line 68 of file SequenceFileStream.C.

---

Member Function Documentation

GenericFrameSpec SequenceFileStream::peekFrameSpec

(

)

[virtual]

get frame specifications, peeking at the first frame if necessary

Implements FrameIstream.

Definition at line 79 of file SequenceFileStream.C.

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

GenericFrame SequenceFileStream::readFrame

(

)

[virtual]

Read the next frame from the seq 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 158 of file SequenceFileStream.C.

References Image< T >::getArrayPtr(), OModelParam< T >::getVal(), GenericFrame::initialized(), rutz::shared_ptr< T >::is_invalid(), and NO_INIT.

Referenced by peekFrameSpec().

void SequenceFileStream::setConfigInfo

(

const std::string &

filename

)

[virtual]

Override from FrameIstream; just calls setFileName().

Reimplemented from FrameIstream.

Definition at line 72 of file SequenceFileStream.C.

References setFileName().

void SequenceFileStream::setFileName

(

const 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 95 of file SequenceFileStream.C.

References OModelParam< T >::getVal(), and rutz::shared_ptr< T >::reset().

Referenced by setConfigInfo().

bool SequenceFileStream::setFrameNumber

(

int

n

)

[virtual]

Override from FrameIstream; sets the current frame number in the sequence.

Reimplemented from FrameIstream.

Definition at line 149 of file SequenceFileStream.C.

---

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

• src/Media/SequenceFileStream.H
• src/Media/SequenceFileStream.C