MirDataRecord Class Reference

a container for a data record read in from a Miriad datatset More...

#include <MirVisReader.h>

Inheritance diagram for MirDataRecord:

List of all members.

Public Member Functions
	MirDataRecord (Int nnarrow=0, Int nwide=0, Int npreamble=5)
	~MirDataRecord ()
uInt	getPreambleCount ()
	return the number of preamble elements
uInt	getNarrowCount ()
	return the number of narrow band channels
uInt	getWideCount ()
	return the number of wide band channels
Double *	preamble ()
	return the address of the preamble buffer
Float *	narrow ()
	return the address of the narrow channel data buffer
Float *	wide ()
	return the address of the wide channel data buffer
Int *	flags ()
	return the address of the flags channel data buffer
Int *	wflags ()
	return the address of the wflags channel data buffer
Int	pol ()
	return the polarization code
void	setPol (Int val)
	set the polarization code
Bool	isMarked ()
	return true if this record is marked
void	setMarked (Bool val)
	set the mark
void	copyFrom (const MirDataRecord &other)
Private Attributes
Int	np_p
Int	nn_p
Int	nw_p
Int	pol_p
Bool	marked_p
Double *	preamble_p
Float *	narrow_p
Float *	wide_p
Int *	flags_p
Int *	wflags_p

---

Detailed Description

a container for a data record read in from a Miriad datatset

Intended use:

Internal

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

this class holds the record-dependent 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.

Access Performance is aided when the data from a Miriad dataset is filled in a particular order. This class provides a container so that the data can be buffered for "sorting" prior to filling into the output MS.

Synopsis

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

Example

Definition at line 91 of file MirVisReader.h.

---

Constructor & Destructor Documentation

MirDataRecord::MirDataRecord	(	Int	nnarrow = 0,
		Int	nwide = 0,
		Int	npreamble = 5
	)

MirDataRecord::~MirDataRecord

(

)

---

Member Function Documentation

void MirDataRecord::copyFrom

(

const MirDataRecord &

other

)

Int* MirDataRecord::flags

(

)

[inline]

return the address of the flags channel data buffer

Definition at line 123 of file MirVisReader.h.

References flags_p.

uInt MirDataRecord::getNarrowCount

(

)

[inline]

return the number of narrow band channels

Definition at line 108 of file MirVisReader.h.

References nn_p.

uInt MirDataRecord::getPreambleCount

(

)

[inline]

return the number of preamble elements

Definition at line 105 of file MirVisReader.h.

References np_p.

uInt MirDataRecord::getWideCount

(

)

[inline]

return the number of wide band channels

Definition at line 111 of file MirVisReader.h.

References nw_p.

Bool MirDataRecord::isMarked

(

)

[inline]

return true if this record is marked

Definition at line 135 of file MirVisReader.h.

References marked_p.

Float* MirDataRecord::narrow

(

)

[inline]

return the address of the narrow channel data buffer

Definition at line 117 of file MirVisReader.h.

References narrow_p.

Int MirDataRecord::pol

(

)

[inline]

return the polarization code

Definition at line 129 of file MirVisReader.h.

References pol_p.

Double* MirDataRecord::preamble

(

)

[inline]

return the address of the preamble buffer

Definition at line 114 of file MirVisReader.h.

References preamble_p.

void MirDataRecord::setMarked

(

Bool

val

)

[inline]

set the mark

Definition at line 138 of file MirVisReader.h.

References marked_p.

void MirDataRecord::setPol

(

Int

val

)

[inline]

set the polarization code

Definition at line 132 of file MirVisReader.h.

References pol_p.

Int* MirDataRecord::wflags

(

)

[inline]

return the address of the wflags channel data buffer

Definition at line 126 of file MirVisReader.h.

References wflags_p.

Float* MirDataRecord::wide

(

)

[inline]

return the address of the wide channel data buffer

Definition at line 120 of file MirVisReader.h.

References wide_p.

---

Member Data Documentation

Int* MirDataRecord::flags_p [private]

Definition at line 97 of file MirVisReader.h.

Referenced by flags().

Bool MirDataRecord::marked_p [private]

Definition at line 93 of file MirVisReader.h.

Referenced by isMarked(), and setMarked().

Float* MirDataRecord::narrow_p [private]

Definition at line 95 of file MirVisReader.h.

Referenced by narrow().

Int MirDataRecord::nn_p [private]

Definition at line 92 of file MirVisReader.h.

Referenced by getNarrowCount().

Int MirDataRecord::np_p [private]

Definition at line 92 of file MirVisReader.h.

Referenced by getPreambleCount().

Int MirDataRecord::nw_p [private]

Definition at line 92 of file MirVisReader.h.

Referenced by getWideCount().

Int MirDataRecord::pol_p [private]

Definition at line 92 of file MirVisReader.h.

Referenced by pol(), and setPol().

Double* MirDataRecord::preamble_p [private]

Definition at line 94 of file MirVisReader.h.

Referenced by preamble().

Int* MirDataRecord::wflags_p [private]

Definition at line 98 of file MirVisReader.h.

Referenced by wflags().

Float* MirDataRecord::wide_p [private]

Definition at line 96 of file MirVisReader.h.

Referenced by wide().

---

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

• code/miriad/Filling/MirVisReader.h