JLANG::JAccessibleInputStream Class Reference

Accessible input stream. More...

#include <JAccessibleStream.hh>

Inheritance diagram for JLANG::JAccessibleInputStream:

Public Member Functions
	JAccessibleInputStream ()
	Default constructor. More...
	JAccessibleInputStream (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 input stream.

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

Definition at line 25 of file JAccessibleStream.hh.

Constructor & Destructor Documentation

JAccessibleInputStream() [1/2]

JLANG::JAccessibleInputStream::JAccessibleInputStream ( )

inline

Default constructor.

Definition at line 33 of file JAccessibleStream.hh.

    {}

JAccessibleInputStream() [2/2]

JLANG::JAccessibleInputStream::JAccessibleInputStream ( const char *  file_name )

inline

Constructor.

Parameters

file_name

file name

Definition at line 42 of file JAccessibleStream.hh.

    {
      open(file_name);
    }

Member Function Documentation

is_open()

virtual bool JLANG::JAccessibleInputStream::is_open ( ) const

inlinevirtual

Check is file is open.

Returns

true if open; else false

Implements JLANG::JAccessible.

Definition at line 53 of file JAccessibleStream.hh.

    {
      return std::ifstream::is_open();
    }

open()

virtual void JLANG::JAccessibleInputStream::open ( const char *  file_name )

inlinevirtual

Open file.

Parameters

file_name

file name

Implements JLANG::JAccessible.

Reimplemented in JLANG::JAccessibleBinaryInputStream.

Definition at line 64 of file JAccessibleStream.hh.

    {
      std::ifstream::open(file_name);
 
      if (!this->is_open()) {
        Throw(JFileOpenException(std::string("Error opening file ") + file_name));
      }
    }

close()

virtual void JLANG::JAccessibleInputStream::close ( )

inlinevirtual

Close file.

Implements JLANG::JAccessible.

Definition at line 77 of file JAccessibleStream.hh.

    {
      std::ifstream::close();
    }

Throw() [1/2]

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

inlinestaticinherited

Enable/disable throw option.

Parameters

option

true enable; false disable

Definition at line 37 of file JThrow.hh.

    {
      do_throw = option;
    }

Throw() [2/2]

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

inlinestaticinherited

Throw exception or return error.

Parameters

error	exception
value	return code

Returns

return code

Definition at line 51 of file JThrow.hh.

    {
      using namespace std;
      
      if (do_throw) {
        throw error;
      }
 
      cerr << error.what() << endl;
      
      return value;
    }

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:

• JAccessibleStream.hh