JLANG::JAbstractFile Class Reference

The JAbstractFile class encapsulates the c-style file descriptor. More...

#include <JAbstractFile.hh>

Inheritance diagram for JLANG::JAbstractFile:

Public Member Functions
	JAbstractFile ()
	Default constructor. More...
	JAbstractFile (const int file)
	Constructor. More...
	JAbstractFile (FILE *stream)
	Constructor. More...
bool	less (const JAbstractFile &file) const
	Less than operation. More...
int	getFileDescriptor () const
	Get file descriptor. More...
void	setFileDescriptor (const int file)
	Set file descriptor. More...
bool	is_open () const
	Get open status. More...

Static Public Attributes
static const int	FILE_CLOSED = -1

Protected Attributes
int	fileDescriptor

Detailed Description

The JAbstractFile class encapsulates the c-style file descriptor.

Definition at line 22 of file JAbstractFile.hh.

Constructor & Destructor Documentation

JAbstractFile() [1/3]

JLANG::JAbstractFile::JAbstractFile ( )

inline

Default constructor.

Definition at line 33 of file JAbstractFile.hh.

                    :
      fileDescriptor(FILE_CLOSED)
    {}

JAbstractFile() [2/3]

JLANG::JAbstractFile::JAbstractFile ( const int  file )

inline

Constructor.

Parameters

file	file descriptor

Definition at line 43 of file JAbstractFile.hh.

                                  :
      fileDescriptor(file)
    {}

JAbstractFile() [3/3]

JLANG::JAbstractFile::JAbstractFile ( FILE *  stream )

inline

Constructor.

Parameters

stream

file stream

Definition at line 53 of file JAbstractFile.hh.

                                :
      fileDescriptor(fileno(stream))
    {}

Member Function Documentation

less()

bool JLANG::JAbstractFile::less ( const JAbstractFile &  file ) const

inline

Less than operation.

Parameters

file	JAbstractFile to be compared

Returns

true if this file descriptor is less; else false

Definition at line 64 of file JAbstractFile.hh.

    {
      return getFileDescriptor() < file.getFileDescriptor();
    }

getFileDescriptor()

int JLANG::JAbstractFile::getFileDescriptor ( ) const

inline

Get file descriptor.

Returns

file descriptor

Definition at line 75 of file JAbstractFile.hh.

    {
      return fileDescriptor;
    }

setFileDescriptor()

void JLANG::JAbstractFile::setFileDescriptor ( const int  file )

inline

Set file descriptor.

Parameters

file	file descriptor

Definition at line 86 of file JAbstractFile.hh.

    {
      fileDescriptor = file;
    }

is_open()

bool JLANG::JAbstractFile::is_open ( ) const

inline

Get open status.

Definition at line 95 of file JAbstractFile.hh.

    {
      return fileDescriptor != FILE_CLOSED;
    }

Member Data Documentation

FILE_CLOSED

const int JLANG::JAbstractFile::FILE_CLOSED = -1

static

Definition at line 27 of file JAbstractFile.hh.

fileDescriptor

int JLANG::JAbstractFile::fileDescriptor

protected

Definition at line 102 of file JAbstractFile.hh.

---

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

• JAbstractFile.hh