casacore
Loading...
Searching...
No Matches
casacore::BlockOutput Class Reference

fixed-length blocked sequential output base class More...

#include <blockio.h>

Public Member Functions

 BlockOutput (const char *, int, int=1, FITSErrorHandler errhandler=FITSError::defaultHandler)
 Construction can be done either from a filename or from a file descriptor.
 BlockOutput (int, int, int=1, FITSErrorHandler errhandler=FITSError::defaultHandler)
virtual ~BlockOutput ()
void flush_buffer ()
virtual int write (char *)
 write the next logical record.
Public Member Functions inherited from casacore::BlockIO
int err () const
int blockno () const
 number of physical blocks read/written
void reset_iosize ()
 reset the m_iosize data member
int iosize () const
 get the total bytes of data in m_buffer
int current () const
 get the current read position within m_buffer
char * buffer () const
 get m_buffer
int recno () const
 number of logical records read/written
const char * fname () const
 name of file associated with I/O stream, if applicable
int close_file (fitsfile *fptr, int *status)
 fits_close_file() does not work for reasons that the file pointer does not have the knowledge of chdu which were written with write_hdr() not write_***_hdr().
int fdes () const
 file descriptor associated with I/O stream, if applicable
fitsfile * getfptr () const
 get the fitsfile pointer
void setfptr (fitsfile *ffp)

Additional Inherited Members

Public Types inherited from casacore::BlockIO
enum  IOErrs {
  OK ,
  NOSUCHFILE ,
  NOMEM ,
  OPENERR ,
  CLOSEERR ,
  READERR ,
  WRITEERR
}
 error return code More...
Protected Member Functions inherited from casacore::BlockIO
 BlockIO (const char *, int, int, int=1, FITSErrorHandler errhandler=FITSError::defaultHandler)
 Construction can be done either from a filename with open options or from a file descriptor.
 BlockIO (int, int, int=1, FITSErrorHandler errhandler=FITSError::defaultHandler)
virtual ~BlockIO ()
void errmsg (IOErrs, const char *)
 set the error message and error number for later recovery
Protected Attributes inherited from casacore::BlockIO
char * m_filename
int m_options
const int m_recsize
const int m_nrec
const int m_blocksize
FITSErrorHandler m_errfn
IOErrs m_err_status
int m_fd
char * m_buffer
int m_block_no
int m_rec_no
int m_current
int m_iosize
 size of record in buffer
fitsfile * m_fptr
 using fitsfile structure from cfitsio of NASA

Detailed Description

fixed-length blocked sequential output base class

Prerequisite

Definition at line 173 of file blockio.h.

Constructor & Destructor Documentation

◆ BlockOutput() [1/2]

casacore::BlockOutput::BlockOutput ( const char * ,
int ,
int = 1,
FITSErrorHandler errhandler = FITSError::defaultHandler )

Construction can be done either from a filename or from a file descriptor.

The remaining arguments are the the logical record size and number of records that make up a physical record followed by the output stream that is used to write error messages to.

References casacore::FITSError::defaultHandler().

◆ BlockOutput() [2/2]

casacore::BlockOutput::BlockOutput ( int ,
int ,
int = 1,
FITSErrorHandler errhandler = FITSError::defaultHandler )

◆ ~BlockOutput()

virtual casacore::BlockOutput::~BlockOutput ( )
virtual

Member Function Documentation

◆ flush_buffer()

void casacore::BlockOutput::flush_buffer ( )

◆ write()

virtual int casacore::BlockOutput::write ( char * )
virtual

write the next logical record.

The input must point to a logical record


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