JEEP::JCommunicator Class Reference

Auxiliary class to control standard input and output. More...

#include <JCommunicator.hh>

Public Member Functions
	JCommunicator ()
	Default constructor. More...
	JCommunicator (const bool verbose)
	Constructor. More...
bool	getVerbose () const
	Get verbose mode. More...
void	setVerbose (const bool verbose=true)
	Set verbose mode. More...
std::istream &	getInputStream (std::istream &in=std::cin) const
	Get current input stream. More...
std::ostream &	getOutputStream (std::ostream &out=std::cout) const
	Get current output stream. More...
std::ostream &	getErrorStream (std::ostream &out=std::cerr) const
	Get current error stream. More...

Protected Attributes
bool	verbose_

Detailed Description

Auxiliary class to control standard input and output.

Definition at line 23 of file JCommunicator.hh.

Constructor & Destructor Documentation

JCommunicator() [1/2]

JEEP::JCommunicator::JCommunicator ( )

inline

Default constructor.

Definition at line 28 of file JCommunicator.hh.

                    :
      verbose_(true)
    {}

JCommunicator() [2/2]

JEEP::JCommunicator::JCommunicator ( const bool  verbose )

inline

Constructor.

Parameters

verbose

disable I/O if false; else enable

Definition at line 38 of file JCommunicator.hh.

                                      :
      verbose_(verbose)
    {}

Member Function Documentation

getVerbose()

bool JEEP::JCommunicator::getVerbose ( ) const

inline

Get verbose mode.

Returns

if true I/O enabled; else disabled

Definition at line 48 of file JCommunicator.hh.

    { 
      return verbose_;
    }

setVerbose()

void JEEP::JCommunicator::setVerbose ( const bool  verbose = true )

inline

Set verbose mode.

Parameters

verbose

disable I/O if false; else enable

Definition at line 59 of file JCommunicator.hh.

    { 
      verbose_ = verbose; 
    }

getInputStream()

std::istream& JEEP::JCommunicator::getInputStream ( std::istream &  in = std::cin ) const

inline

Get current input stream.

This method returns the given input stream if the verbose option is set, else a streamer that does not read any input.

Parameters

in	input stream

Returns

input stream

Definition at line 73 of file JCommunicator.hh.

    {
      return (verbose_ ? in : JLANG::null);
    }

getOutputStream()

std::ostream& JEEP::JCommunicator::getOutputStream ( std::ostream &  out = std::cout ) const

inline

Get current output stream.

This method returns the given output stream if the verbose option is set, else a streamer that does not write any output.

Parameters

out	output stream

Returns

output stream

Definition at line 87 of file JCommunicator.hh.

    {
      return (verbose_ ? out : JLANG::null);
    }

getErrorStream()

std::ostream& JEEP::JCommunicator::getErrorStream ( std::ostream &  out = std::cerr ) const

inline

Get current error stream.

This method returns the given error stream if the verbose option is set, else a streamer that does not write any output.

Parameters

out	error stream

Returns

error stream

Definition at line 101 of file JCommunicator.hh.

    {
      //return (verbose_ ? out : JLANG::null);
      return out;
    }

Member Data Documentation

verbose_

bool JEEP::JCommunicator::verbose_

protected

Definition at line 109 of file JCommunicator.hh.

---

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

• JCommunicator.hh