MirHisReader Class Reference

a Miriad history reader More...

#include <MirVisReader.h>

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

Private Attributes
casacore::Int	uv_handle_p
casacore::Int	eof_p
casacore::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 180 of file MirVisReader.h.

Constructor & Destructor Documentation

MirHisReader::MirHisReader ( casacore::Int  mirhandle )

inline

create a History reader from a Miriad file handle

Definition at line 188 of file MirVisReader.h.

References hisopen_c(), and uv_handle_p.

MirHisReader::~MirHisReader ( )

inline

delete the reader

Definition at line 193 of file MirVisReader.h.

References hisclose_c(), and uv_handle_p.

Member Function Documentation

casacore::Bool MirHisReader::atEnd ( )

inline

return true this reader there is no more history to read

Definition at line 198 of file MirVisReader.h.

References eof_p.

Referenced by readLine().

casacore::Bool MirHisReader::readLine ( casacore::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 203 of file MirVisReader.h.

References atEnd(), eof_p, hisread_c(), hline, and uv_handle_p.

Member Data Documentation

casacore::Int MirHisReader::eof_p

private

Definition at line 182 of file MirVisReader.h.

Referenced by atEnd(), and readLine().

casacore::Char MirHisReader::hline[256]

private

Definition at line 183 of file MirVisReader.h.

Referenced by readLine().

casacore::Int MirHisReader::uv_handle_p

private

Definition at line 182 of file MirVisReader.h.

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

---

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

• casa/code/miriad/Filling/MirVisReader.h