VLABaselineRecord Class Reference

#include <VLABaselineRecord.h>

Inheritance diagram for VLABaselineRecord:

Public Types
enum	Type {   CONTINUUM,   SPECTRALLINE,   UNKNOWN_TYPE,   NUMBER_TYPES }
	The shapes of all the components. More...

Public Member Functions
virtual	~VLABaselineRecord ()
	A virtual destructor is needed to ensure that the destructor of derived classes is actually used. More...
virtual casacore::Vector < casacore::Complex >	data () const
	returns the correlations for this baseline. More...
virtual void	data (casacore::Array< casacore::Complex > &values) const =0
	Returns the correlations for this baseline in the supplied Array. More...
virtual casacore::Vector < casacore::Bool >	flags () const =0
	returns the flags for the correlations for this baseline. More...
virtual casacore::uInt	scale () const =0
	returns the scaling factor used to convert the internal data to the actual values. More...
virtual casacore::uInt	ant1 () const =0
	returns the antenna 1 index for this baseline. More...
virtual casacore::uInt	ant2 () const =0
	returns the antenna 2 index for this baseline. More...
virtual VLABaselineRecord::Type	type () const =0
	return the type of this class More...

Static Public Member Functions
static casacore::String	name (VLABaselineRecord::Type typeEnum)
	Convert a Type enum into a String. More...
static VLABaselineRecord::Type	type (const casacore::String &typeName)
	Convert a given casacore::String to a Type enumerator. More...

Protected Member Functions
	VLABaselineRecord ()
	function to turn an object constructed this way into a usable object. More...
	VLABaselineRecord (casacore::ByteSource &record, casacore::uInt offset)
void	attach (casacore::ByteSource &record, casacore::uInt offset)
casacore::uInt	scale (casacore::uInt headerOffset) const
casacore::uInt	ant1 (casacore::uInt headerOffset) const
casacore::uInt	ant2 (casacore::uInt headerOffset) const

Protected Attributes
casacore::ByteSource	itsRecord
casacore::uInt	itsOffset

Private Member Functions
	VLABaselineRecord (const VLABaselineRecord &other)
VLABaselineRecord &	operator= (const VLABaselineRecord &other)

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 92 of file VLABaselineRecord.h.

Member Enumeration Documentation

enum VLABaselineRecord::Type

The shapes of all the components.

Enumerator
CONTINUUM	A simple point component.
SPECTRALLINE	A elliptical Gaussian component.
UNKNOWN_TYPE	An unknown Component.
NUMBER_TYPES	The number of types in this enumerator.

Definition at line 96 of file VLABaselineRecord.h.

Constructor & Destructor Documentation

virtual VLABaselineRecord::~VLABaselineRecord ( )

virtual

A virtual destructor is needed to ensure that the destructor of derived classes is actually used.

VLABaselineRecord::VLABaselineRecord ( )

protected

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

VLABaselineRecord::VLABaselineRecord ( casacore::ByteSource &  record, casacore::uInt  offset  )

protected

VLABaselineRecord::VLABaselineRecord ( const VLABaselineRecord &  other )

private

Member Function Documentation

virtual casacore::uInt VLABaselineRecord::ant1 ( ) const

pure virtual

returns the antenna 1 index for this baseline.

Implemented in VLAContinuumRecord, and VLASpectralLineRecord.

casacore::uInt VLABaselineRecord::ant1 ( casacore::uInt  headerOffset ) const

protected

virtual casacore::uInt VLABaselineRecord::ant2 ( ) const

pure virtual

returns the antenna 2 index for this baseline.

Implemented in VLAContinuumRecord, and VLASpectralLineRecord.

casacore::uInt VLABaselineRecord::ant2 ( casacore::uInt  headerOffset ) const

protected

void VLABaselineRecord::attach ( casacore::ByteSource &  record, casacore::uInt  offset  )

protected

virtual casacore::Vector<casacore::Complex> VLABaselineRecord::data ( ) const

virtual

returns the correlations for this baseline.

The returned casacore::Vector contains all the data for this baseline and has been scaled.

Reimplemented in VLASpectralLineRecord, and VLAContinuumRecord.

virtual void VLABaselineRecord::data ( casacore::Array< casacore::Complex > &  values ) const

pure virtual

Returns the correlations for this baseline in the supplied Array.

The supplied casacore::Array may have any number of dimensions, but all except one must have a length on 1. The axis that is not of length one must be the right length to hold all the data contained in the record. Alternatively the casacore::Array may contain no elements in which case it will be resized to a Vector of the correct length. The returned values have been scaled.

Implemented in VLASpectralLineRecord, and VLAContinuumRecord.

virtual casacore::Vector<casacore::Bool> VLABaselineRecord::flags ( ) const

pure virtual

returns the flags for the correlations for this baseline.

Implemented in VLASpectralLineRecord, and VLAContinuumRecord.

static casacore::String VLABaselineRecord::name ( VLABaselineRecord::Type  typeEnum )

static

Convert a Type enum into a String.

VLABaselineRecord& VLABaselineRecord::operator= ( const VLABaselineRecord &  other )

private

virtual casacore::uInt VLABaselineRecord::scale ( ) const

pure virtual

returns the scaling factor used to convert the internal data to the actual values.

Implemented in VLAContinuumRecord, and VLASpectralLineRecord.

casacore::uInt VLABaselineRecord::scale ( casacore::uInt  headerOffset ) const

protected

virtual VLABaselineRecord::Type VLABaselineRecord::type ( ) const

pure virtual

return the type of this class

Implemented in VLAContinuumRecord, and VLASpectralLineRecord.

static VLABaselineRecord::Type VLABaselineRecord::type ( const casacore::String &  typeName )

static

Convert a given casacore::String to a Type enumerator.

Member Data Documentation

casacore::uInt VLABaselineRecord::itsOffset

protected

Definition at line 173 of file VLABaselineRecord.h.

casacore::ByteSource VLABaselineRecord::itsRecord

mutableprotected

Definition at line 170 of file VLABaselineRecord.h.

---

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

• casa/code/nrao/VLA/VLABaselineRecord.h