lsst::ap::io::SequentialIoBase Class Reference

Abstract base class for sequential I/O classes. More...

#include <FileIo.h>

Inheritance diagram for lsst::ap::io::SequentialIoBase:

Public Types
enum	State { IN_PROGRESS = 0, FINISHED, FAILED }

Public Member Functions
	SequentialIoBase ()
virtual	~SequentialIoBase ()=0
bool	finished () const
	Returns true if there are no more bytes available for reading. More...
bool	failed () const
	Returns true if a read operation failed. More...
State	getState () const
	Returns the state of the SequentialReader. More...

Protected Attributes
State	_state

Detailed Description

Abstract base class for sequential I/O classes.

Definition at line 50 of file FileIo.h.

Member Enumeration Documentation

enum lsst::ap::io::SequentialIoBase::State

Enumerator
IN_PROGRESS
FINISHED
FAILED

Definition at line 54 of file FileIo.h.

               {
        IN_PROGRESS = 0,
        FINISHED,
        FAILED
    };

Constructor & Destructor Documentation

lsst::ap::io::SequentialIoBase::SequentialIoBase

(

)

Definition at line 83 of file FileIo.cc.

: _state(IN_PROGRESS) {}

lsst::ap::io::SequentialIoBase::~SequentialIoBase ( )

pure virtual

Definition at line 85 of file FileIo.cc.

{}

Member Function Documentation

bool lsst::ap::io::SequentialIoBase::failed ( ) const

inline

Returns true if a read operation failed.

Definition at line 68 of file FileIo.h.

{ return _state == FAILED; }

bool lsst::ap::io::SequentialIoBase::finished ( ) const

inline

Returns true if there are no more bytes available for reading.

Definition at line 65 of file FileIo.h.

{ return _state == FINISHED; }

State lsst::ap::io::SequentialIoBase::getState ( ) const

inline

Returns the state of the SequentialReader.

Definition at line 71 of file FileIo.h.

{ return _state; }

Member Data Documentation

State lsst::ap::io::SequentialIoBase::_state

protected

Definition at line 75 of file FileIo.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/io/FileIo.h
• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/src/io/FileIo.cc