NullOutputStream Class Reference

NullOutputStream writes nothing, it is a fake output stream. More...

#include <Media/NullOutputStream.H>

Inheritance diagram for NullOutputStream:

[legend]

Collaboration diagram for NullOutputStream:

[legend]

List of all members.

Public Member Functions
	NullOutputStream (OptionManager &mgr, const std::string &descrName="Null Output Stream", const std::string &tagName="NullOutputStream")
	Construct an mpegstream object for mpeg output.
virtual	~NullOutputStream ()
	Destructor.
virtual void	writeFrame (const GenericFrame &frame, const std::string &shortname, const FrameInfo &auxinfo=FrameOstream::defaultInfo)
	Write a frame to null.
virtual void	closeStream (const std::string &shortname)
	Do nothing.

---

Detailed Description

NullOutputStream writes nothing, it is a fake output stream.

This may be useful in situations where you want to guarantee that you are running a model in the exact same conditions as you would normally do when you write, e.g., a movie out with your results, except that you don't want to spend the time encoding the movie. Typically this may be useful while doing parameter searches where you want to process data but do not need the visual displays until you have found your final set of parameters. With NullOutputStream selected as output, you will still go through the motions of building output frames as you normally would, just they will not be saved anywhere.

Definition at line 59 of file NullOutputStream.H.

---

Constructor & Destructor Documentation

NullOutputStream::NullOutputStream	(	OptionManager &	mgr,
		const std::string &	descrName = "Null Output Stream",
		const std::string &	tagName = "NullOutputStream"
	)

Construct an mpegstream object for mpeg output.

Definition at line 46 of file NullOutputStream.C.

NullOutputStream::~NullOutputStream

(

)

[virtual]

Destructor.

Definition at line 53 of file NullOutputStream.C.

---

Member Function Documentation

void NullOutputStream::closeStream

(

const std::string &

shortname

)

[virtual]

Do nothing.

Implements FrameOstream.

Definition at line 65 of file NullOutputStream.C.

void NullOutputStream::writeFrame	(	const GenericFrame &	frame,
		const std::string &	shortname,
		const FrameInfo &	auxinfo = FrameOstream::defaultInfo
	)			[virtual]

Write a frame to null.

We just print a message and discard the frame.

Implements FrameOstream.

Definition at line 57 of file NullOutputStream.C.

---

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

• src/Media/NullOutputStream.H
• src/Media/NullOutputStream.C