Public Member Functions | Private Attributes | List of all members
ecl::interfaces::OutputTextStream< Device, true > Class Template Reference

Output text stream interface. More...

#include <output_text_stream.hpp>

Inheritance diagram for ecl::interfaces::OutputTextStream< Device, true >:
Inheritance graph
[legend]

Public Member Functions

template<typename Action >
OutputTextStream< Device > &operator<< (const char &c) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const char *s) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const std::string &s) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const short &i) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const int &i) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const long &i) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const long long &i) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const unsigned short &i) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const unsigned int &i) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const unsigned long &i) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const unsigned long long &i) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const bool b) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const float &f) ecl_assert_throw_decl(ecl OutputTextStream< Device > &operator<< (const double &d) ecl_assert_throw_decl(ecl OutputTextStream< Device > & operator<< (ecl::Manipulator< Action > &manipulator) ecl_assert_throw_decl(ecl
 
template<typename Device >
OutputTextStream< Device > & operator<< (const double &d) ecl_assert_throw_decl(ecl
 
template<typename Device >
OutputTextStream< Device > & operator<< (const char &c) ecl_assert_throw_decl(ecl
 Sends an unformatted char to the stream. Sends an unformatted char to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const bool b) ecl_assert_throw_decl(ecl
 Sends a boolean to the stream. Sends a boolean to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const unsigned long long &i) ecl_assert_throw_decl(ecl
 Sends an unformatted unsigned long long to the stream. Sends an unformatted unsigned long long to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const unsigned long &i) ecl_assert_throw_decl(ecl
 Sends an unformatted unsigned long to the stream. Sends an unformatted unsigned long to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const int &i) ecl_assert_throw_decl(ecl
 Sends an unformatted int to the stream. Sends an unformatted int to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const unsigned short &i) ecl_assert_throw_decl(ecl
 Sends an unformatted unsigned short to the stream. Sends an unformatted unsigned short to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const long long &i) ecl_assert_throw_decl(ecl
 Sends an unformatted long long to the stream. Sends an unformatted long long to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const float &f) ecl_assert_throw_decl(ecl
 
template<typename Device >
OutputTextStream< Device > & operator<< (const long &i) ecl_assert_throw_decl(ecl
 Sends an unformatted long to the stream. Sends an unformatted long to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const short &i) ecl_assert_throw_decl(ecl
 Sends an unformatted short to the stream. Sends an unformatted short to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const unsigned int &i) ecl_assert_throw_decl(ecl
 Sends an unformatted unsigned int to the stream. Sends an unformatted unsigned int to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const char *s) ecl_assert_throw_decl(ecl
 Sends an unformatted char string to the stream. Sends an unformatted char string to the stream. More...
 
template<typename Device >
OutputTextStream< Device > & operator<< (const std::string &s) ecl_assert_throw_decl(ecl
 Sends an unformatted string to the stream. Sends an unformatted string to the stream. More...
 
 OutputTextStream ()
 Connects the stream to an output device. More...
 
virtual ~OutputTextStream ()
 
- Public Member Functions inherited from ecl::interfaces::BaseTextStream< Device >
 BaseTextStream ()
 
Device & device ()
 Provides access to the underlying output device. More...
 
const ecl::Error & errorStatus () const
 Enumeration indicating the exit status of the last read operation. More...
 
bool fail () const
 Denotes the status of the last device operation. More...
 
virtual ~BaseTextStream ()
 

Private Attributes

ecl::Converter< char * > toCharString
 

Additional Inherited Members

- Protected Attributes inherited from ecl::interfaces::BaseTextStream< Device >
ecl::Error error
 
Device io_device
 

Detailed Description

template<typename Device>
class ecl::interfaces::OutputTextStream< Device, true >

Output text stream interface.

Defines the appropriate functionality required for output text streams.

Template Parameters
Device: this must be a class that satisfies the output device concept (refer to the documentation in ecl_concepts for details).

Usage:

TextStream<OFile> ofstream;
ofstream.device().open("dudes.txt",New);
ofstream << "dudes " << 32.36;
ofstream.flush();

Definition at line 80 of file output_text_stream.hpp.

Constructor & Destructor Documentation

template<typename Device >
ecl::interfaces::OutputTextStream< Device, true >::OutputTextStream ( )
inline

Connects the stream to an output device.

Connects the text stream to the associated output device. Use the device() handle to properly open the device, e.g.

OutputTextStream<OFile> ofstream;
ofstream.device().open("dudes.txt",New);

Definition at line 93 of file output_text_stream.hpp.

template<typename Device >
virtual ecl::interfaces::OutputTextStream< Device, true >::~OutputTextStream ( )
inlinevirtual

Definition at line 99 of file output_text_stream.hpp.

Member Function Documentation

template<typename Device >
template<typename Action >
OutputTextStream<Device>& operator<< ( const char &c ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const char *s ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const std::string &s ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const short &i ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const int &i ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const long &i ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const long long &i ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const unsigned short &i ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const unsigned int &i ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const unsigned long &i ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const unsigned long long &i ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const bool b ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const float &f ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& operator<< ( const double &d ) ecl_assert_throw_decl(ecl OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( ecl::Manipulator< Action > &  manipulator)
inline

Definition at line 120 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const double &  d)

Sends an unformatted double to the stream.

Parameters
d: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation.

Definition at line 346 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const float &  f)

Sends an unformatted float to the stream.

Parameters
f: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 332 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const bool  b)

Sends a boolean to the stream. Sends a boolean to the stream.

Parameters
b: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 318 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const unsigned long long &  i)

Sends an unformatted unsigned long long to the stream. Sends an unformatted unsigned long long to the stream.

Parameters
i: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 304 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const unsigned long &  i)

Sends an unformatted unsigned long to the stream. Sends an unformatted unsigned long to the stream.

Parameters
i: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 290 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const unsigned int &  i)

Sends an unformatted unsigned int to the stream. Sends an unformatted unsigned int to the stream.

Parameters
i: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 275 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const unsigned short &  i)

Sends an unformatted unsigned short to the stream. Sends an unformatted unsigned short to the stream.

Parameters
i: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 260 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const long long &  i)

Sends an unformatted long long to the stream. Sends an unformatted long long to the stream.

Parameters
i: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 245 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const long &  i)

Sends an unformatted long to the stream. Sends an unformatted long to the stream.

Parameters
i: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 230 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const int &  i)

Sends an unformatted int to the stream. Sends an unformatted int to the stream.

Parameters
i: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 215 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const short &  i)

Sends an unformatted short to the stream. Sends an unformatted short to the stream.

Parameters
i: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 201 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const std::string &  s)

Sends an unformatted string to the stream. Sends an unformatted string to the stream.

Parameters
s: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 188 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const char *  s)

Sends an unformatted char string to the stream. Sends an unformatted char string to the stream.

Parameters
s: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 173 of file output_text_stream.hpp.

template<typename Device >
template<typename Device >
OutputTextStream<Device>& ecl::interfaces::OutputTextStream< Device, true >::operator<< ( const char &  c)

Sends an unformatted char to the stream. Sends an unformatted char to the stream.

Parameters
c: input value being sent to the stream
Exceptions
ecl::StandardException: throws if the underlying device has not been opened [debug mode only].
Returns
OutputTextStream : returns the stream for further manipulation

Definition at line 159 of file output_text_stream.hpp.

Member Data Documentation

template<typename Device >
ecl::Converter<char*> ecl::interfaces::OutputTextStream< Device, true >::toCharString
private

Provides a streaming operator for handling output textstream manipulators. Manipulators are simple functions that accept the stream as input and manipulate it in a minor way. They can hold no state. The most common example of such a manipulator is the endln manipulator. This manipulator works in the same fashion as the c++ endl manipulator.

Definition at line 141 of file output_text_stream.hpp.

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

ecl_streams
Author(s): Daniel Stonier
autogenerated on Mon Jun 10 2019 13:08:50