MirHisReader Class Reference

a Miriad history reader More...

#include <MirVisReader.h>

List of all members.

Public Member Functions

 MirHisReader (Int mirhandle)
 create a History reader from a Miriad file handle
 ~MirHisReader ()
 delete the reader
Bool atEnd ()
 return true this reader there is no more history to read
Bool readLine (String &line)
 read the next available line into a String.

Private Attributes

Int uv_handle_p
Int eof_p
Char hline [256]

Detailed Description

a Miriad history reader

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Etymology

Class name is short for Miriad history reader.

Motivation

Miriad history is read independently from the visibility data; thus, an independent class is in order. This class hides the details of how to read Miriad history.

Synopsis

This class is used to extract history from a Miriad visibility dataset. Normally, an application does not create this class by itself, but rather via MirVisReader::openHistory();

Example

Definition at line 176 of file MirVisReader.h.


Constructor & Destructor Documentation

MirHisReader::MirHisReader ( Int  mirhandle  )  [inline]

create a History reader from a Miriad file handle

Definition at line 184 of file MirVisReader.h.

References uv_handle_p.

MirHisReader::~MirHisReader (  )  [inline]

delete the reader

Definition at line 189 of file MirVisReader.h.

References uv_handle_p.


Member Function Documentation

Bool MirHisReader::atEnd (  )  [inline]

return true this reader there is no more history to read

Definition at line 194 of file MirVisReader.h.

References eof_p.

Referenced by readLine().

Bool MirHisReader::readLine ( String &  line  )  [inline]

read the next available line into a String.

True is returned if line was successfully loaded; False is returned if the last line had already been read.

Definition at line 199 of file MirVisReader.h.

References atEnd(), eof_p, casacore::False, hline, casacore::True, and uv_handle_p.


Member Data Documentation

Int MirHisReader::eof_p [private]

Definition at line 178 of file MirVisReader.h.

Referenced by atEnd(), and readLine().

Char MirHisReader::hline[256] [private]

Definition at line 179 of file MirVisReader.h.

Referenced by readLine().

Definition at line 178 of file MirVisReader.h.

Referenced by MirHisReader(), readLine(), and ~MirHisReader().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1