VLAEnum Class Reference

Enumerators common to the VLA module. More...

#include <VLAEnum.h>

List of all members.

Public Types

enum  IF {
  IFA,
  IFB,
  IFC,
  IFD
}
 

Names for all the IF's.

More...
enum  CDA {
  CDA0,
  CDA1,
  CDA2,
  CDA3
}
 

Names for the different correlator data areas's.

More...
enum  CorrMode {
  CONTINUUM,
  A,
  B,
  C,
  D,
  AB,
  AC,
  AD,
  BC,
  BD,
  CD,
  ABCD,
  PA,
  PB,
  OLDA,
  OLDB,
  OLDC,
  OLDD,
  NUMBER_MODES,
  UNKNOWN_MODE
}
 

A list of the different correlator Modes.

More...

Static Public Member Functions

static String name (VLAEnum::CorrMode modeEnum)
 Convert the CorrMode enumerator to a string.
static VLAEnum::CorrMode corrMode (const String &modeString)
 Convert a given String to a CorrMode enumerator.

Detailed Description

Enumerators common to the VLA module.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd
Test programs:
tComponentEnum

Etymology

This class contains the enumerator definitions used in the VLA module

Synopsis

This class does nothing. It is merely a container for the enumerations used by the VLA module. These enumerations define the standard values that enforce, at compile time, a stricter type checking than would be achieved by using integers.

Example

To Do

Definition at line 65 of file VLAEnum.h.


Member Enumeration Documentation

Names for the different correlator data areas's.

Enumerator:
CDA0 

IF A is at freq 1 and normally is right-hand polarised.

CDA1 

IF B is at freq 2 and normally is right-hand polarised.

CDA2 

IF C is at freq 1 and normally is left-hand polarised.

CDA3 

IF D is at freq 2 and normally is left-hand polarised.

Definition at line 80 of file VLAEnum.h.

A list of the different correlator Modes.


Warning: Because enumerators cannot start with a numerical value the string representation of the enumerator is different from the enumerator token;

Enumerator:
CONTINUUM 

Continuum mode.

Four correlation products, at two spectral id's, using IF's A,B,C and D. All other modes are spectral line.

A 

Spectral line mode with one correlation product, at one spectral id, using IF A.

B 

Spectral line mode with one correlation product, at one spectral id, using IF B.

C 

Spectral line mode with one correlation product, at one spectral id, using IF C.

D 

Spectral line mode with one correlation product, at one spectral id, using IF D.

AB 

Spectral line mode with two correlation products, at two spectral id's, using IF's A and B.

AC 

Spectral line mode with two correlation products, at one spectral id, using IF's A and C.

AD 

Spectral line mode with two correlation products, at two spectral id's, using IF's A and D.

BC 

Spectral line mode with two correlation products, at two spectral id's, using IF's B and C.

BD 

Spectral line mode with two correlation products, at one spectral id, using IF's B and D.

CD 

Spectral line mode with two correlation products, at two spectral id's, using IF's C and D.

ABCD 

Spectral line mode with four correlation products, at two spectral id's, using IF's A,B,C and D.

PA 

Spectral line mode with four correlation products, at one spectral id, using IF's A and C.

PB 

Spectral line mode with four correlation products, at one spectral id, using IF's B and D.

OLDA 
OLDB 
OLDC 
OLDD 
NUMBER_MODES 

The number of valid modes in this enumerator.

UNKNOWN_MODE 

An unknown correlator mode.

Definition at line 96 of file VLAEnum.h.

Names for all the IF's.

Enumerator:
IFA 

IF A is at freq 1 and normally is right-hand polarised.

IFB 

IF B is at freq 2 and normally is right-hand polarised.

IFC 

IF C is at freq 1 and normally is left-hand polarised.

IFD 

IF D is at freq 2 and normally is left-hand polarised.

Definition at line 68 of file VLAEnum.h.


Member Function Documentation

static VLAEnum::CorrMode VLAEnum::corrMode ( const String &  modeString  )  [static]

Convert a given String to a CorrMode enumerator.

static String VLAEnum::name ( VLAEnum::CorrMode  modeEnum  )  [static]

Convert the CorrMode enumerator to a string.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1