casacore
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
casacore::MEpoch Class Reference

More...

#include <MEpoch.h>

Public Types

enum  Types {
  LAST ,
  LMST ,
  GMST1 ,
  GAST ,
  UT1 ,
  UT2 ,
  UTC ,
  TAI ,
  TDT ,
  TCG ,
  TDB ,
  TCB ,
  N_Types ,
  RAZE ,
  EXTRA ,
  IAT ,
  GMST ,
  TT ,
  UT ,
  ET ,
  DEFAULT
}
 Types of known MEpochs
Caution: The order defines the order in the translation matrix in the MCEpoch class; Do not change the order without changing the array; Additions should be made before N_types, and an additional row and column should be coded in FromTo (MCEpoch), and in showType();
More...
 
typedef MVEpoch MVType
 Measure value container for this class (i.e. More...
 
typedef MCEpoch MCType
 Measure conversion routines for this class (i.e. More...
 
typedef MeasRef< MEpochRef
 Measure reference (i.e. More...
 
typedef MeasConvert< MEpochConvert
 Measure Convert (i.e. More...
 
typedef ScalarMeasColumn< MEpochScalarColumn
 Measure table Columns (e.g., MEpoch::ScalarColumn) More...
 
typedef ArrayMeasColumn< MEpochArrayColumn
 
- Public Types inherited from casacore::Measure
enum  Types {
  N_Types ,
  DEFAULT
}
 Each derived class should have a Types enumeration, specifying the recognised frame types. More...
 
typedef void * Convert
 Each Measure should have typedefs of the form: More...
 

Public Member Functions

 MEpoch ()
 Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measure::TYPE where no offsets or frames are needed in the reference;
Default constructor; generates an instant at MJD 0 UTC More...
 
 MEpoch (const MVEpoch &dt)
 Create from data and reference. More...
 
 MEpoch (const MVEpoch &dt, const MEpoch::Ref &rf)
 
 MEpoch (const MVEpoch &dt, MEpoch::Types rf)
 
 MEpoch (const Quantity &dt)
 
 MEpoch (const Quantity &dt, const MEpoch::Ref &rf)
 
 MEpoch (const Quantity &dt, MEpoch::Types rf)
 
 MEpoch (const Measure *dt)
 
 MEpoch (const MeasValue *dt)
 
virtual ~MEpoch ()
 
virtual const StringtellMe () const
 Tell me your type. More...
 
Bool giveMe (MEpoch::Ref &mr, const String &in)
 
virtual Bool setOffset (const Measure &in)
 Set the offset in the reference (False if non-matching Measure) More...
 
virtual Bool setRefString (const String &in)
 Set the reference type to the specified String. More...
 
virtual const StringgetDefaultType () const
 Get the default reference type. More...
 
virtual const StringallTypes (Int &nall, Int &nextra, const uInt *&typ) const
 Get a list of all known reference codes. More...
 
virtual void checkTypes () const
 Check if all internal tables of types (both enum and String) are complete and correct. More...
 
virtual String getRefString () const
 Get the reference type (for records, including codes like R_) More...
 
Quantity get (const Unit &inunit) const
 Get time in specified units. More...
 
virtual Measureclone () const
 Create copy. More...
 
- Public Member Functions inherited from casacore::MeasBase< MVEpoch, MeasRef< MEpoch > >
 MeasBase ()
 Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measure::TYPE where no offsets or frames are needed in the reference; For reasons of compiler limitations the formal arguments had to be specified as uInt rather than the Measure enums that should be used as actual arguments;
Default constructor More...
 
 MeasBase (const MeasBase< MVEpoch, MeasRef< MEpoch > > &other)
 Copy constructor. More...
 
 MeasBase (const MVEpoch &dt, const MeasRef< MEpoch > &rf)
 Create from data and reference. More...
 
 MeasBase (const MVEpoch &dt, uInt rf)
 
 MeasBase (const Quantity &dt, const MeasRef< MEpoch > &rf)
 
 MeasBase (const Quantity &dt, uInt rf)
 
 MeasBase (const Measure *dt)
 
 MeasBase (const MeasRef< MEpoch > &rf)
 
 MeasBase (const uInt rf)
 
MeasBase< MVEpoch, MeasRef< MEpoch > > & operator= (const MeasBase< MVEpoch, MeasRef< MEpoch > > &other)
 Copy assignment. More...
 
virtual ~MeasBase ()
 
virtual Bool areYou (const String &tp) const
 Check the type of derived entity. More...
 
virtual void assured (const String &tp) const
 Assert that we are the correct type. More...
 
void set (const MVEpoch &dt)
 Refill the specified entities. More...
 
void set (const MeasRef< MEpoch > &rf)
 
void set (const MVEpoch &dt, const MeasRef< MEpoch > &rf)
 
void set (const Unit &inunit)
 
virtual void set (const MeasValue &dt)
 Each Measure should have the following set functions (with appropiate MVs and Ref): More...
 
virtual Bool putValue (const Vector< Quantum< Double > > &in)
 
MeasRef< MEpochgetRef () const
 Get reference. More...
 
const MVEpochgetValue () const
 Get Measure data. More...
 
const UnitgetUnit () const
 Get Unit. More...
 
virtual MRBasegetRefPtr () const
 Get reference pointer. More...
 
virtual const MeasValuegetData () const
 Get pointer to data. More...
 
virtual void print (std::ostream &os) const
 Print a Measure. More...
 
- Public Member Functions inherited from casacore::Measure
virtual ~Measure ()
 Destructor. More...
 
virtual Bool isModel () const
 Tell me if you are a pure model (e.g. More...
 
void dummy_giveMe () const
 Each derived class should have a string-to-code translation routine for the reference type. More...
 
void dummy_getRef () const
 Each class should have a function to return its reference: More...
 
void dummy_getValue () const
 Each derived class should be able to get its internal value and have: More...
 

Static Public Member Functions

static const StringshowMe ()
 
static void assure (const Measure &in)
 
static MEpoch::Types castType (uInt tp)
 Translate reference code. More...
 
static const StringshowType (MEpoch::Types tp)
 
static const StringshowType (uInt tp)
 
static Bool getType (MEpoch::Types &tp, const String &in)
 Translate string to reference code. More...
 
static const StringallMyTypes (Int &nall, Int &nextra, const uInt *&typ)
 
static void checkMyTypes ()
 
- Static Public Member Functions inherited from casacore::Measure
static uInt giveMe (const String &in, Int N_name, const String tname[])
 A general string checking routine to be used in derived measures. More...
 

Friends

class MeasConvert< MEpoch >
 

Additional Inherited Members

- Protected Attributes inherited from casacore::MeasBase< MVEpoch, MeasRef< MEpoch > >
MVEpoch data
 The measure value (e.g. More...
 
MeasRef< MEpochref
 Reference frame data. More...
 
Unit unit
 Possible input units. More...
 

Detailed Description

A Measure: instant in time

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

Measure and Epoch

Synopsis

MEpoch forms derived Measure class for an instant in time.

Example

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

#include <casacore/measures/Measures.h>
#include <casacore/measures/Measures/MEpoch.h>
#include <casacore/measures/Measures/MCEpoch.h>
#include <casacore/casa/logging/LogIO.h>
cout << "TAI for UTC = MJD(50237.29): " <<
MEpoch::Convert(MEpoch(MVEpoch(Quantity(50237.29, "d")),
endl;
LogIO os(LogOrigin("FluxCalc_SS_JPL_Butler", "readEphem"));
os << LogIO::DEBUG1 << " at ";
os.output() << MEpoch::Convert(MEpoch(MVEpoch(Quantity(50237.29, "d")),
@ DEBUG1
Change the message priority to DEBUGGING.
Definition: LogIO.h:190
@ POST
Post the accumulated message.
Definition: LogIO.h:173
MeasRef< MEpoch > Ref
Measure reference (i.e.
Definition: MEpoch.h:156
MeasConvert< MEpoch > Convert
Measure Convert (i.e.
Definition: MEpoch.h:158
MEpoch()
Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measu...
Quantum< Double > Quantity
Definition: Quantum.h:38

Results in:

TAI for UTC = MJD(50237.29): Epoch: 50237::06:58:06.0000 (on stdout)
at Epoch: 50237::06:58:06.0000 (in logger)

Motivation

To Do

Definition at line 104 of file MEpoch.h.

Member Typedef Documentation

◆ ArrayColumn

Definition at line 161 of file MEpoch.h.

◆ Convert

Measure Convert (i.e.

MEpoch::Convert)

Definition at line 158 of file MEpoch.h.

◆ MCType

Measure conversion routines for this class (i.e.

MEpoch::MCType)

Definition at line 154 of file MEpoch.h.

◆ MVType

Measure value container for this class (i.e.

MEpoch::MVType)

Definition at line 152 of file MEpoch.h.

◆ Ref

Measure reference (i.e.

MEpoch::Ref)

Definition at line 156 of file MEpoch.h.

◆ ScalarColumn

Measure table Columns (e.g., MEpoch::ScalarColumn)

Definition at line 160 of file MEpoch.h.

Member Enumeration Documentation

◆ Types

Types of known MEpochs
Caution: The order defines the order in the translation matrix in the MCEpoch class; Do not change the order without changing the array; Additions should be made before N_types, and an additional row and column should be coded in FromTo (MCEpoch), and in showType();

Enumerator
LAST 

Local Apparent Sidereal Time.

LMST 

Local Mean Sidereal Time.

GMST1 

Greenwich Mean ST1.

GAST 

Greenwich Apparent ST.

UT1 
UT2 
UTC 
TAI 
TDT 
TCG 
TDB 
TCB 
N_Types 

Number of types.

RAZE 

Reduce result to integer days.

EXTRA 

All extra bits.

IAT 

Synonyms.

GMST 
TT 
UT 
ET 
DEFAULT 

Default.

Definition at line 117 of file MEpoch.h.

Constructor & Destructor Documentation

◆ MEpoch() [1/9]

casacore::MEpoch::MEpoch ( )

Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measure::TYPE where no offsets or frames are needed in the reference;
Default constructor; generates an instant at MJD 0 UTC

◆ MEpoch() [2/9]

casacore::MEpoch::MEpoch ( const MVEpoch dt)

Create from data and reference.

◆ MEpoch() [3/9]

casacore::MEpoch::MEpoch ( const MVEpoch dt,
const MEpoch::Ref rf 
)

◆ MEpoch() [4/9]

casacore::MEpoch::MEpoch ( const MVEpoch dt,
MEpoch::Types  rf 
)

◆ MEpoch() [5/9]

casacore::MEpoch::MEpoch ( const Quantity dt)

◆ MEpoch() [6/9]

casacore::MEpoch::MEpoch ( const Quantity dt,
const MEpoch::Ref rf 
)

◆ MEpoch() [7/9]

casacore::MEpoch::MEpoch ( const Quantity dt,
MEpoch::Types  rf 
)

◆ MEpoch() [8/9]

casacore::MEpoch::MEpoch ( const Measure dt)

◆ MEpoch() [9/9]

casacore::MEpoch::MEpoch ( const MeasValue dt)

◆ ~MEpoch()

virtual casacore::MEpoch::~MEpoch ( )
virtual

Member Function Documentation

◆ allMyTypes()

static const String* casacore::MEpoch::allMyTypes ( Int nall,
Int nextra,
const uInt *&  typ 
)
static

◆ allTypes()

virtual const String* casacore::MEpoch::allTypes ( Int nall,
Int nextra,
const uInt *&  typ 
) const
virtual

Get a list of all known reference codes.

nall returns the number in list, nextra the number of specials (like planets) that should be at end of list). typ returns the list of corresponding types.

Reimplemented from casacore::Measure.

◆ assure()

static void casacore::MEpoch::assure ( const Measure in)
static

◆ castType()

static MEpoch::Types casacore::MEpoch::castType ( uInt  tp)
static

Translate reference code.

The uInt version has a check for valid codes (i.e. it is a safe cast).

Thrown Exceptions

  • AipsError in the uInt interface if illegal code given

◆ checkMyTypes()

static void casacore::MEpoch::checkMyTypes ( )
static

◆ checkTypes()

virtual void casacore::MEpoch::checkTypes ( ) const
virtual

Check if all internal tables of types (both enum and String) are complete and correct.

This function is called automatically if and when necessary.

Thrown Exceptions

  • AipsError if a (programming) error in the types.

Implements casacore::Measure.

◆ clone()

virtual Measure* casacore::MEpoch::clone ( ) const
virtual

Create copy.

Implements casacore::Measure.

◆ get()

Quantity casacore::MEpoch::get ( const Unit inunit) const

Get time in specified units.

◆ getDefaultType()

virtual const String& casacore::MEpoch::getDefaultType ( ) const
virtual

Get the default reference type.

Implements casacore::Measure.

◆ getRefString()

virtual String casacore::MEpoch::getRefString ( ) const
virtual

Get the reference type (for records, including codes like R_)

Implements casacore::Measure.

◆ getType()

static Bool casacore::MEpoch::getType ( MEpoch::Types tp,
const String in 
)
static

Translate string to reference code.

◆ giveMe()

Bool casacore::MEpoch::giveMe ( MEpoch::Ref mr,
const String in 
)

◆ setOffset()

virtual Bool casacore::MEpoch::setOffset ( const Measure in)
virtual

Set the offset in the reference (False if non-matching Measure)

Implements casacore::Measure.

◆ setRefString()

virtual Bool casacore::MEpoch::setRefString ( const String in)
virtual

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casacore::Measure.

◆ showMe()

static const String& casacore::MEpoch::showMe ( )
static

◆ showType() [1/2]

static const String& casacore::MEpoch::showType ( MEpoch::Types  tp)
static

◆ showType() [2/2]

static const String& casacore::MEpoch::showType ( uInt  tp)
static

◆ tellMe()

virtual const String& casacore::MEpoch::tellMe ( ) const
virtual

Tell me your type.

Implements casacore::Measure.

Friends And Related Function Documentation

◆ MeasConvert< MEpoch >

friend class MeasConvert< MEpoch >
friend

Definition at line 1 of file MEpoch.h.


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