MCEarthMagnetic.h

Classes

MCEarthMagnetic -- MEarthMagnetic conversion routines (full description)

class MCEarthMagnetic : public MCBase

Types

enum Routes

GAL_J2000
GAL_B1950
J2000_GAL
B1950_GAL
J2000_B1950
B1950_J2000
J2000_JMEAN
B1950_BMEAN
JMEAN_J2000
JMEAN_JTRUE
BMEAN_B1950
BMEAN_BTRUE
JTRUE_JMEAN
BTRUE_BMEAN
J2000_JNAT
JNAT_J2000
B1950_APP
APP_B1950
APP_TOPO
HADEC_AZEL
HADEC_AZELGEO
AZEL_HADEC
AZELGEO_HADEC
HADEC_TOPO
AZEL_AZELSW
AZELGEO_AZELSWGEO
AZELSW_AZEL
AZELSWGEO_AZELGEO
APP_JNAT
JNAT_APP
J2000_ECLIP
ECLIP_J2000
JMEAN_MECLIP
MECLIP_JMEAN
JTRUE_TECLIP
TECLIP_JTRUE
GAL_SUPERGAL
SUPERGAL_GAL
ITRF_HADEC
HADEC_ITRF
TOPO_HADEC
TOPO_APP
ICRS_J2000
J2000_ICRS
N_Routes
R_MODEL0
General for Models
R_MODEL
R_IGRF
Individual models. Order should be the same as in MEarthMagnetic.h

Interface

Public Members
MCEarthMagnetic()
~MCEarthMagnetic()
static String showState()
Private Members
MCEarthMagnetic(const MCEarthMagnetic &other)
MCEarthMagnetic &operator=(const MCEarthMagnetic &other)
virtual void getConvert(MConvertBase &mc, const MRBase &inref, const MRBase &outref)
virtual void initConvert(uInt which, MConvertBase &mc)
virtual void clearConvert()
virtual void doConvert(MeasValue &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
void doConvert(MVEarthMagnetic &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)

Description

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25
Programs:
Tests:

Prerequisite

Etymology

Measure, Convert and EarthMagnetic

Synopsis

Contains state machinery and caching for actual conversions

Example

See Measures module description for conversion examples.

Motivation

To Do

Member Description

MCEarthMagnetic()

Default constructor

~MCEarthMagnetic()

static String showState()

Show the state of the conversion engine (mainly for debugging purposes)

enum Routes

The list of actual routines provided.
Warning Each AA_BB in the list points to routine that can be used in the FromTo list in the getConvert routine. In addition the type to which each is converted should be in the ToRef array, again in the proper order.

MCEarthMagnetic(const MCEarthMagnetic &other)

Copy constructor (not implemented)

MCEarthMagnetic &operator=(const MCEarthMagnetic &other)

Assignment (not implemented)

virtual void getConvert(MConvertBase &mc, const MRBase &inref, const MRBase &outref)

Create conversion function pointer

virtual void initConvert(uInt which, MConvertBase &mc)

Create help structures for Measure conversion routines

virtual void clearConvert()

Delete the pointers used in the MeasConvert help structure cache

virtual void doConvert(MeasValue &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)

Routines to convert EarthMagnetics from one reference frame to another

void doConvert(MVEarthMagnetic &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)

Conversion routine to cater for inheritance question