casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
VLACDA Class Reference

#include <VLACDA.h>

Public Member Functions

 VLACDA ()
 The default constructor creates a unusable object. More...
 
 VLACDA (casacore::ByteSource &record, casacore::uInt offset, casacore::uInt baselineSize, casacore::uInt nant, casacore::uInt nChan)
 Initialise this CDA from the given BytesSource (which must contain a VLA logical record), and must be readable & seekable. More...
 
 VLACDA (const VLACDA &other)
 The copy constructor uses copy semantics. More...
 
 ~VLACDA ()
 The destructor is trivial. More...
 
VLACDAoperator= (const VLACDA &other)
 The assignment constructor uses copy semantics. More...
 
void attach (casacore::ByteSource &record, casacore::uInt offset, casacore::uInt baselineSize, casacore::uInt nant, casacore::uInt nChan)
 Initialise this CDA from the given BytesSource (which must contain a VLA logical record), and must be readable & seekable. More...
 
casacore::Bool isValid () const
 Return true if the CDA contains valid data. More...
 
const VLABaselineRecordautoCorr (casacore::uInt which) const
 return the specified baseline record corresponding to the specified auto-correlation. More...
 
const VLABaselineRecordcrossCorr (casacore::uInt which) const
 return the specified baseline record corresponding to the specified cross-correlation. More...
 

Private Member Functions

void deleteACorr (casacore::uInt startIndex)
 
void deleteXCorr (casacore::uInt startIndex)
 

Private Attributes

casacore::ByteSource itsRecord
 
casacore::uInt itsOffset
 the offset to the start of this CDA in the record. More...
 
casacore::uInt itsBaselineSize
 A cached value of the size, in bytes, of a baseline record. More...
 
casacore::uInt itsNant
 A cached value of the number of antennas that this CDU has data for. More...
 
casacore::uInt itsNchan
 A cached value of the number of channels that this CDU has data for. More...
 
casacore::PtrBlock
< VLABaselineRecord * > 
itsACorr
 
casacore::PtrBlock
< VLABaselineRecord * > 
itsXCorr
 

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

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 ( casacore::ByteSource record,
casacore::uInt  offset,
casacore::uInt  baselineSize,
casacore::uInt  nant,
casacore::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 ( casacore::ByteSource record,
casacore::uInt  offset,
casacore::uInt  baselineSize,
casacore::uInt  nant,
casacore::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 ( casacore::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 ( casacore::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 ( casacore::uInt  startIndex)
private
void VLACDA::deleteXCorr ( casacore::uInt  startIndex)
private
casacore::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

casacore::PtrBlock<VLABaselineRecord*> VLACDA::itsACorr
mutableprivate

Definition at line 151 of file VLACDA.h.

casacore::uInt VLACDA::itsBaselineSize
private

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

Definition at line 140 of file VLACDA.h.

casacore::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.

casacore::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.

casacore::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.

casacore::ByteSource VLACDA::itsRecord
mutableprivate

Definition at line 133 of file VLACDA.h.

casacore::PtrBlock<VLABaselineRecord*> VLACDA::itsXCorr
mutableprivate

Definition at line 156 of file VLACDA.h.


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