MirDataBuffer Class Reference

a buffer for data read in from a Miriad datatset More...

#include <MirDataBuffer.h>

Public Member Functions
	MirDataBuffer (...)
	create the container
Boolean	hasMore ()
	return true if there is still data to be read from the dataset
void	varUpdated (Boolean val)
	set the variable update state.
Boolean	isVarUpdated ()
	return the variable update state.
float *	operator[] (Int i)
	return a pointer to the i-th record in this buffer
double *	getPreamble (Int i)
	return the preamble for the i-th record
double	getTime ()
	return the current Miriad timestamp
Int	getBaselineNum (Int i)
	return the baseline number for the i-th record
double *	getBaselineVec (Int i)
	return the baseline vector as a 3-element array holding u, v, & w
Int	getPol (Int i)
	return the Miriad polarization code for the i-th record
Int	size ()
	return the number of records held in this buffer
void	reset ()
	update the number of records held by the buffer
Private Member Functions
	MirDataBuffer (MirDataBuffer &)
Private Attributes
Boolean	upd
Boolean	hasmore
Block< int >	pol
Block< double * >	preamble
Block< float * >	narrow
Block< float * >	wide
Int	nrec
Int	nnar
Int	nwide

Detailed Description

a buffer for data read in from a Miriad datatset

Intended use:

Internal

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

this class buffers data from a Miriad dataset

Motivation

MSes filled from Miriad data feature multiple windows of differing shapes. Performance during MS reads can be aided by collecting together MS table records of the same shape (e.g. of the same window). MirFiller accoplishes this by reading all baselines from a single timestamp at once, so that they written out in order of spectral window. This class provides a container for holding the data from different baselines.

Synopsis

At the moment, this is intended for use only by the MirFiller class.

Example

Definition at line 77 of file MirDataBuffer.h.

Constructor & Destructor Documentation

MirDataBuffer::MirDataBuffer ( MirDataBuffer & ) [private]

MirDataBuffer::MirDataBuffer ( ... )

create the container

Member Function Documentation

Int MirDataBuffer::getBaselineNum ( Int i ) [inline]

return the baseline number for the i-th record

Definition at line 118 of file MirDataBuffer.h.

References preamble.

double* MirDataBuffer::getBaselineVec ( Int i ) [inline]

return the baseline vector as a 3-element array holding u, v, & w

Definition at line 121 of file MirDataBuffer.h.

References preamble.

Int MirDataBuffer::getPol ( Int i ) [inline]

return the Miriad polarization code for the i-th record

Definition at line 124 of file MirDataBuffer.h.

References pol.

double* MirDataBuffer::getPreamble ( Int i ) [inline]

return the preamble for the i-th record

Definition at line 112 of file MirDataBuffer.h.

References preamble.

double MirDataBuffer::getTime ( ) [inline]

return the current Miriad timestamp

Definition at line 115 of file MirDataBuffer.h.

References preamble.

Boolean MirDataBuffer::hasMore ( ) [inline]

return true if there is still data to be read from the dataset

Definition at line 94 of file MirDataBuffer.h.

References hasmore.

Boolean MirDataBuffer::isVarUpdated ( ) [inline]

return the variable update state.

A value of True means that some variables have changed and should be checked for new values. False means that the variables have not changed since the last time they were checked.

Definition at line 106 of file MirDataBuffer.h.

References upd.

float* MirDataBuffer::operator[] ( Int i ) [inline]

return a pointer to the i-th record in this buffer

Definition at line 109 of file MirDataBuffer.h.

void MirDataBuffer::reset ( void ) [inline]

update the number of records held by the buffer

reset the buffer for a new time slot

switch cached record into first position

Definition at line 132 of file MirDataBuffer.h.

References casacore::False, hasmore, narrow, pol, preamble, and wide.

Int MirDataBuffer::size ( ) [inline]

return the number of records held in this buffer

Definition at line 127 of file MirDataBuffer.h.

References nrec.

void MirDataBuffer::varUpdated ( Boolean val ) [inline]

set the variable update state.

A value of True means that some variables have changed and should be checked for new values. False means that the variables have not changed since the last time they were checked.

Definition at line 100 of file MirDataBuffer.h.

References upd.