Public Member Functions | List of all members
ecl::SharedFileStream Class Reference

Convenience class for SharedFile TextStream definitions. More...

#include <shared_file_stream.hpp>

Inheritance diagram for ecl::SharedFileStream:
Inheritance graph
[legend]

Public Member Functions

 SharedFileStream ()
 Default constructor, underlying device must be manually opened. More...
 
 SharedFileStream (const std::string &file_name, const WriteMode &mode=New)
 Convenience constructor for shared file text streams. More...
 
virtual ~SharedFileStream ()
 
- Public Member Functions inherited from ecl::TextStream< SharedFile >
virtual ~TextStream ()
 

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.

See also
TextStream.

Definition at line 43 of file shared_file_stream.hpp.

Constructor & Destructor Documentation

◆ SharedFileStream() [1/2]

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 51 of file shared_file_stream.hpp.

◆ SharedFileStream() [2/2]

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 63 of file shared_file_stream.hpp.

◆ ~SharedFileStream()

virtual ecl::SharedFileStream::~SharedFileStream ( )
inlinevirtual

Definition at line 72 of file shared_file_stream.hpp.


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


ecl_streams
Author(s): Daniel Stonier
autogenerated on Thu Jun 6 2019 21:59:07