Jpp  19.1.0
the software that should make you happy
Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
JLANG::JAccessibleOutputStream Class Reference

Accessible output stream. More...

#include <JAccessibleStream.hh>

Inheritance diagram for JLANG::JAccessibleOutputStream:
JLANG::JAccessible JLANG::JThrow< JAccessible > JLANG::JASCIIFileWriter< T > JLANG::JAccessibleBinaryOutputStream JSUPPORT::JMonteCarloFileWriter< T > JIO::JBinaryFileWriter< JPhotonPath > JIO::JBinaryFileWriter< T > JSUPPORT::JDAQFileWriter< T > JMARKOV::JPhotonPathWriter

Public Member Functions

 JAccessibleOutputStream ()
 Default constructor. More...
 
 JAccessibleOutputStream (const char *file_name)
 Constructor. More...
 
virtual bool is_open () const
 Check is file is open. More...
 
virtual void open (const char *file_name)
 Open file. More...
 
virtual void close ()
 Close file. More...
 

Static Public Member Functions

static void Throw (const bool option)
 Enable/disable throw option. More...
 
static int Throw (const JException_t &error, const int value=-1)
 Throw exception or return error. More...
 

Static Protected Attributes

static bool do_throw
 throw option More...
 

Detailed Description

Accessible output stream.

This class is a simple wrapper around the std::ofstream class. It class implements the JAccessible interface.

Definition at line 90 of file JAccessibleStream.hh.

Constructor & Destructor Documentation

◆ JAccessibleOutputStream() [1/2]

JLANG::JAccessibleOutputStream::JAccessibleOutputStream ( )
inline

Default constructor.

Definition at line 98 of file JAccessibleStream.hh.

99  {}

◆ JAccessibleOutputStream() [2/2]

JLANG::JAccessibleOutputStream::JAccessibleOutputStream ( const char *  file_name)
inline

Constructor.

Parameters
file_namefile name

Definition at line 107 of file JAccessibleStream.hh.

108  {
109  open(file_name);
110  }
virtual void open(const char *file_name)
Open file.

Member Function Documentation

◆ is_open()

virtual bool JLANG::JAccessibleOutputStream::is_open ( ) const
inlinevirtual

Check is file is open.

Returns
true if open; else false

Implements JLANG::JAccessible.

Definition at line 118 of file JAccessibleStream.hh.

119  {
120  return std::ofstream::is_open();
121  }

◆ open()

virtual void JLANG::JAccessibleOutputStream::open ( const char *  file_name)
inlinevirtual

Open file.

Parameters
file_namefile name

Implements JLANG::JAccessible.

Reimplemented in JLANG::JAccessibleBinaryOutputStream.

Definition at line 129 of file JAccessibleStream.hh.

130  {
131  std::ofstream::open(file_name);
132 
133  if (!this->is_open()) {
134  Throw(JFileOpenException(std::string("Error opening file ") + file_name));
135  }
136  }
virtual bool is_open() const
Check is file is open.
Exception for opening of file.
Definition: JException.hh:360
static void Throw(const bool option)
Enable/disable throw option.
Definition: JThrow.hh:37
T * open(const std::string &file_name)
Open file.
Definition: JeepToolkit.hh:351

◆ close()

virtual void JLANG::JAccessibleOutputStream::close ( )
inlinevirtual

Close file.

Implements JLANG::JAccessible.

Definition at line 142 of file JAccessibleStream.hh.

143  {
145  }
void close(std::istream *pf)
Close file.
Definition: JeepToolkit.hh:391

◆ Throw() [1/2]

static void JLANG::JThrow< JAccessible >::Throw ( const bool  option)
inlinestaticinherited

Enable/disable throw option.

Parameters
optiontrue enable; false disable

Definition at line 37 of file JThrow.hh.

38  {
39  do_throw = option;
40  }
static bool do_throw
throw option
Definition: JThrow.hh:28

◆ Throw() [2/2]

static int JLANG::JThrow< JAccessible >::Throw ( const JException_t &  error,
const int  value = -1 
)
inlinestaticinherited

Throw exception or return error.

Parameters
errorexception
valuereturn code
Returns
return code

Definition at line 51 of file JThrow.hh.

52  {
53  using namespace std;
54 
55  if (do_throw) {
56  throw error;
57  }
58 
59  cerr << error.what() << endl;
60 
61  return value;
62  }
Definition: JSTDTypes.hh:14

Member Data Documentation

◆ do_throw

bool JLANG::JThrow< JAccessible >::do_throw
staticprotectedinherited

throw option

Set default throw option to true.

Definition at line 28 of file JThrow.hh.


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