ecl::SharedFileStream Class Reference

Convenience class for SharedFile TextStream definitions. More...

Inheritance diagram for ecl::SharedFileStream:

Public Member Functions
	SharedFileStream (const std::string &file_name, const WriteMode &mode=New) ecl_throw_decl(StandardException)
	Convenience constructor for shared file text streams.
	SharedFileStream ()
	Default constructor, underlying device must be manually opened.
virtual	~SharedFileStream ()

Detailed Description

Convenience class for SharedFile TextStream definitions.

This class provides a convenient handle for both writing and opening TextStream<SharedFile> objects. It has no further functionality.

Definition at line 42 of file shared_file_stream.hpp.

ecl::SharedFileStream::SharedFileStream ( ) [inline]

Default constructor, underlying device must be manually opened.

This must open the device manually via device().open() as you would do if using a TextStream.

Definition at line 50 of file shared_file_stream.hpp.

ecl::SharedFileStream::SharedFileStream	(	const std::string &	file_name,
		const WriteMode &	mode = `New`
	)			`[inline]`

Convenience constructor for shared file text streams.

This constructor enables RAII style construction of the underlying device (this makes it distinct from a generic TextStream<SharedFile> object).

Parameters:

	file_name	: output file name.
	mode	: mode for writing (New, Append).

Exceptions:

StandardException

: throws if the connection failed to open.

Definition at line 62 of file shared_file_stream.hpp.

virtual ecl::SharedFileStream::~SharedFileStream ( ) [inline, virtual]

Definition at line 71 of file shared_file_stream.hpp.

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