#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.
virtual Vector< Complex >	data () const
	returns the correlations for this baseline.
virtual void	data (Array< Complex > &values) const =0
	Returns the correlations for this baseline in the supplied Array.
virtual Vector< Bool >	flags () const =0
	returns the flags for the correlations for this baseline.
virtual uInt	scale () const =0
	returns the scaling factor used to convert the internal data to the actual values.
virtual uInt	ant1 () const =0
	returns the antenna 1 index for this baseline.
virtual uInt	ant2 () const =0
	returns the antenna 2 index for this baseline.
virtual VLABaselineRecord::Type	type () const =0
	return the type of this class
Static Public Member Functions
static String	name (VLABaselineRecord::Type typeEnum)
	Convert a Type enum into a String.
static VLABaselineRecord::Type	type (const String &typeName)
	Convert a given String to a Type enumerator.
Protected Member Functions
	VLABaselineRecord ()
	function to turn an object constructed this way into a usable object.
	VLABaselineRecord (ByteSource &record, uInt offset)
void	attach (ByteSource &record, uInt offset)
uInt	scale (uInt headerOffset) const
uInt	ant1 (uInt headerOffset) const
uInt	ant2 (uInt headerOffset) const
Protected Attributes
ByteSource	itsRecord
uInt	itsOffset
Private Member Functions
	VLABaselineRecord (const VLABaselineRecord &other)
VLABaselineRecord &	operator= (const VLABaselineRecord &other)

Detailed Description

Intended use:

Public interface

 <h3>Review Status</h3><dl><dt>Date Reviewed:<dd>yyyy/mm/dd</dl>

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 88 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 92 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	(	ByteSource &	record,
		uInt	offset
	)		`[protected]`

VLABaselineRecord::VLABaselineRecord ( const VLABaselineRecord & other ) [private]

Member Function Documentation

virtual uInt VLABaselineRecord::ant1 ( ) const [pure virtual]

returns the antenna 1 index for this baseline.

Implemented in VLAContinuumRecord, and VLASpectralLineRecord.

uInt VLABaselineRecord::ant1 ( uInt headerOffset ) const [protected]

virtual uInt VLABaselineRecord::ant2 ( ) const [pure virtual]

returns the antenna 2 index for this baseline.

Implemented in VLAContinuumRecord, and VLASpectralLineRecord.

uInt VLABaselineRecord::ant2 ( uInt headerOffset ) const [protected]

void VLABaselineRecord::attach	(	ByteSource &	record,
		uInt	offset
	)		`[protected]`

Reimplemented in VLAContinuumRecord.

virtual Vector<Complex> VLABaselineRecord::data ( ) const [virtual]

returns the correlations for this baseline.

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

Reimplemented in VLAContinuumRecord, and VLASpectralLineRecord.

virtual void VLABaselineRecord::data ( Array< Complex > & values ) const [pure virtual]

Returns the correlations for this baseline in the supplied Array.

The supplied 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 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 VLAContinuumRecord, and VLASpectralLineRecord.

virtual Vector<Bool> VLABaselineRecord::flags ( ) const [pure virtual]

returns the flags for the correlations for this baseline.

Implemented in VLAContinuumRecord, and VLASpectralLineRecord.

static String VLABaselineRecord::name ( VLABaselineRecord::Type typeEnum ) [static]