casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
casacore::MCEpoch Class Reference

MEpoch conversion routines. More...

#include <MCEpoch.h>

Inheritance diagram for casacore::MCEpoch:
casacore::MCBase

Public Member Functions

 MCEpoch ()
 Default constructor. More...
 
 ~MCEpoch ()
 
- Public Member Functions inherited from casacore::MCBase
virtual ~MCBase ()
 

Static Public Member Functions

static String showState ()
 Show the state of the conversion engine (mainly for debugging purposes) More...
 

Private Types

enum  Routes {
  LAST_GAST,
  GAST_LAST,
  LMST_GMST1,
  GMST1_LMST,
  GMST1_UT1,
  UT1_GMST1,
  GAST_UT1,
  UT1_GAST,
  UT1_UTC,
  UTC_UT1,
  UT1_UT2,
  UT2_UT1,
  UTC_TAI,
  TAI_UTC,
  TAI_TDT,
  TDT_TAI,
  TDT_TDB,
  TDB_TDT,
  TDT_TCG,
  TCG_TDT,
  TDB_TCB,
  TCB_TDB,
  N_Routes,
  RAZING
}
 The list of actual routines provided. More...
 

Private Member Functions

 MCEpoch (const MCEpoch &other)
 Copy constructor (not implemented) More...
 
MCEpochoperator= (const MCEpoch &other)
 Assignment (not implemented) More...
 
virtual void getConvert (MConvertBase &mc, const MRBase &inref, const MRBase &outref)
 Create conversion function pointer. More...
 
virtual void initConvert (uInt which, MConvertBase &mc)
 Create help structures for Measure conversion routines. More...
 
virtual void clearConvert ()
 Delete the pointers used in the MeasConvert help structure cache. More...
 
virtual void doConvert (MeasValue &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
 Routine to convert time from one reference frame to another. More...
 
void doConvert (MVEpoch &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
 Conversion routine to cater for inheritance question. More...
 

Static Private Member Functions

static void doFillState ()
 Fill the global state. More...
 

Private Attributes

NutationNUTATFROM
 
NutationNUTATTO
 

Static Private Attributes

static uInt ToRef_p [N_Routes][3]
 Transition list. More...
 
static uInt FromTo_p [MEpoch::N_Types][MEpoch::N_Types]
 Transition matrix. More...
 
static std::once_flag theirInitOnceFlag
 Object to ensure safe multi-threaded lazy single initialization. More...
 

Friends

class MeasConvert< MEpoch >
 

Additional Inherited Members

- Public Types inherited from casacore::MCBase
enum  Routes { N_Routes }
 Each derived class should have a list of routines to be called: More...
 
- Static Protected Member Functions inherited from casacore::MCBase
static void makeState (uInt *state, const uInt ntyp, const uInt nrout, const uInt list[][3])
 
The following routines create a state transition matrix from a list

of all defined transitions. More...

 
static String showState (uInt *state, const uInt ntyp, const uInt nrout, const uInt list[][3])
 Return a fromatted String with matrix information (based on < 100 types) More...
 

Detailed Description

MEpoch conversion routines.

Intended use:

Internal

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25
Test programs:
tMeasure

Prerequisite

Etymology

Measure, Convert and Epoch

Synopsis

Contains state machinery and caching for actual conversions

Example

Convert (with all steps explicit) a UTC to an IAT time.

cout << "TAI for UTC = MJD(50237.29): " <<
MEpoch::Convert(MEpoch(MVEpoch(Quantity(50237.29, "d")),
endl;

Motivation

To Do

Definition at line 91 of file MCEpoch.h.

Member Enumeration Documentation

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;

Enumerator
LAST_GAST 
GAST_LAST 
LMST_GMST1 
GMST1_LMST 
GMST1_UT1 
UT1_GMST1 
GAST_UT1 
UT1_GAST 
UT1_UTC 
UTC_UT1 
UT1_UT2 
UT2_UT1 
UTC_TAI 
TAI_UTC 
TAI_TDT 
TDT_TAI 
TDT_TDB 
TDB_TDT 
TDT_TCG 
TCG_TDT 
TDB_TCB 
TCB_TDB 
N_Routes 
RAZING 

Definition at line 116 of file MCEpoch.h.

Constructor & Destructor Documentation

casacore::MCEpoch::MCEpoch ( )

Default constructor.

casacore::MCEpoch::~MCEpoch ( )
casacore::MCEpoch::MCEpoch ( const MCEpoch other)
private

Copy constructor (not implemented)

Member Function Documentation

virtual void casacore::MCEpoch::clearConvert ( )
privatevirtual

Delete the pointers used in the MeasConvert help structure cache.

Implements casacore::MCBase.

virtual void casacore::MCEpoch::doConvert ( MeasValue in,
MRBase inref,
MRBase outref,
const MConvertBase mc 
)
privatevirtual

Routine to convert time from one reference frame to another.

Implements casacore::MCBase.

void casacore::MCEpoch::doConvert ( MVEpoch in,
MRBase inref,
MRBase outref,
const MConvertBase mc 
)
private

Conversion routine to cater for inheritance question.

static void casacore::MCEpoch::doFillState ( )
staticprivate

Fill the global state.

Called using theirInitOnce.

virtual void casacore::MCEpoch::getConvert ( MConvertBase mc,
const MRBase inref,
const MRBase outref 
)
privatevirtual

Create conversion function pointer.

Implements casacore::MCBase.

virtual void casacore::MCEpoch::initConvert ( uInt  which,
MConvertBase mc 
)
privatevirtual

Create help structures for Measure conversion routines.

Implements casacore::MCBase.

MCEpoch& casacore::MCEpoch::operator= ( const MCEpoch other)
private

Assignment (not implemented)

static String casacore::MCEpoch::showState ( )
static

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

Friends And Related Function Documentation

friend class MeasConvert< MEpoch >
friend

Definition at line 96 of file MCEpoch.h.

Member Data Documentation

uInt casacore::MCEpoch::FromTo_p[MEpoch::N_Types][MEpoch::N_Types]
staticprivate

Transition matrix.

Definition at line 159 of file MCEpoch.h.

Nutation* casacore::MCEpoch::NUTATFROM
private

Definition at line 152 of file MCEpoch.h.

Nutation* casacore::MCEpoch::NUTATTO
private

Definition at line 153 of file MCEpoch.h.

std::once_flag casacore::MCEpoch::theirInitOnceFlag
staticprivate

Object to ensure safe multi-threaded lazy single initialization.

Definition at line 161 of file MCEpoch.h.

uInt casacore::MCEpoch::ToRef_p[N_Routes][3]
staticprivate

Transition list.

Definition at line 157 of file MCEpoch.h.


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