VLACDA Class Reference

#include <VLACDA.h>

List of all members.

Public Member Functions
	VLACDA ()
	The default constructor creates a unusable object.
	VLACDA (ByteSource &record, uInt offset, uInt baselineSize, uInt nant, uInt nChan)
	Initialise this CDA from the given BytesSource (which must contain a VLA logical record), and must be readable & seekable.
	VLACDA (const VLACDA &other)
	The copy constructor uses copy semantics.
	~VLACDA ()
	The destructor is trivial.
VLACDA &	operator= (const VLACDA &other)
	The assignment constructor uses copy semantics.
void	attach (ByteSource &record, uInt offset, uInt baselineSize, uInt nant, uInt nChan)
	Initialise this CDA from the given BytesSource (which must contain a VLA logical record), and must be readable & seekable.
Bool	isValid () const
	Return True if the CDA contains valid data.
const VLABaselineRecord &	autoCorr (uInt which) const
	return the specified baseline record corresponding to the specified auto-correlation.
const VLABaselineRecord &	crossCorr (uInt which) const
	return the specified baseline record corresponding to the specified cross-correlation.
Private Member Functions
void	deleteACorr (uInt startIndex)
void	deleteXCorr (uInt startIndex)
Private Attributes
ByteSource	itsRecord
uInt	itsOffset
	the offset to the start of this CDA in the record.
uInt	itsBaselineSize
	A cached value of the size, in bytes, of a baseline record.
uInt	itsNant
	A cached value of the number of antennas that this CDU has data for.
uInt	itsNchan
	A cached value of the number of channels that this CDU has data for.
PtrBlock< VLABaselineRecord * >	itsACorr
PtrBlock< VLABaselineRecord * >	itsXCorr

---

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• SomeClass
• SomeOtherClass
• some concept

Etymology

Synopsis

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

• add this feature
• fix this bug
• start discussion of this possible extension

Definition at line 79 of file VLACDA.h.

---

Constructor & Destructor Documentation

VLACDA::VLACDA

(

)

The default constructor creates a unusable object.

Use the attach function to turn an object constructed this way into a usable object.

VLACDA::VLACDA	(	ByteSource &	record,
		uInt	offset,
		uInt	baselineSize,
		uInt	nant,
		uInt	nChan
	)

Initialise this CDA from the given BytesSource (which must contain a VLA logical record), and must be readable & seekable.

The offset specifies where the CDA starts in the logical record. The number of antennas and channels in this CDA, as well as the size of a baseline record, must also be specified.

VLACDA::VLACDA

(

const VLACDA &

other

)

The copy constructor uses copy semantics.

VLACDA::~VLACDA

(

)

The destructor is trivial.

---

Member Function Documentation

void VLACDA::attach	(	ByteSource &	record,
		uInt	offset,
		uInt	baselineSize,
		uInt	nant,
		uInt	nChan
	)

Initialise this CDA from the given BytesSource (which must contain a VLA logical record), and must be readable & seekable.

The offset specifies where the CDA starts in the logical record. The number of antennas and channels in this CDA, as well as the size of a baseline record, must also be specified.

const VLABaselineRecord& VLACDA::autoCorr

(

uInt

which

)

const

return the specified baseline record corresponding to the specified auto-correlation.

The index must be less than the number of antennas in this subarray otherwise an exception is thrown.

const VLABaselineRecord& VLACDA::crossCorr

(

uInt

which

)

const

return the specified baseline record corresponding to the specified cross-correlation.

The index must be less than NANT*(NANT-1)/2 otherwise an exception is thrown.

void VLACDA::deleteACorr

(

uInt

startIndex

)

[private]

void VLACDA::deleteXCorr

(

uInt

startIndex

)

[private]

Bool VLACDA::isValid

(

)

const

Return True if the CDA contains valid data.

This, and the copy functions, will not throw an exception if the CDA does not contain data.

VLACDA& VLACDA::operator=

(

const VLACDA &

other

)

The assignment constructor uses copy semantics.

---

Member Data Documentation

PtrBlock<VLABaselineRecord*> VLACDA::itsACorr [mutable, private]

Definition at line 151 of file VLACDA.h.

uInt VLACDA::itsBaselineSize [private]

A cached value of the size, in bytes, of a baseline record.

Definition at line 140 of file VLACDA.h.

uInt VLACDA::itsNant [private]

A cached value of the number of antennas that this CDU has data for.

Definition at line 143 of file VLACDA.h.

uInt VLACDA::itsNchan [private]

A cached value of the number of channels that this CDU has data for.

Definition at line 146 of file VLACDA.h.

uInt VLACDA::itsOffset [private]

the offset to the start of this CDA in the record.

An offset of zero means this CDA is not used in this record.

Definition at line 137 of file VLACDA.h.

ByteSource VLACDA::itsRecord [mutable, private]

Definition at line 133 of file VLACDA.h.

PtrBlock<VLABaselineRecord*> VLACDA::itsXCorr [mutable, private]

Definition at line 156 of file VLACDA.h.

---

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

• code/nrao/VLA/VLACDA.h