casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends
casa::MVTime Class Reference

Class to handle date/time type conversions and I/O. More...

#include <MVTime.h>

List of all members.

Classes

class  Format
 Format structure. More...

Public Types

enum  formatTypes {
  ANGLE,
  TIME,
  CLEAN,
  NO_D,
  NO_DM,
  YMD,
  DMY,
  DAY,
  NO_TIME,
  MJD,
  DIG2,
  FITS,
  LOCAL,
  NO_H,
  NO_HM,
  ANGLE_CLEAN,
  ANGLE_NO_D,
  ANGLE_NO_DM,
  ANGLE_CLEAN_NO_D,
  ANGLE_CLEAN_NO_DM,
  TIME_CLEAN,
  TIME_NO_H,
  TIME_NO_HM,
  TIME_CLEAN_NO_H,
  TIME_CLEAN_NO_HM,
  YMD_ONLY,
  MOD_MASK
}
 Format types. More...

Public Member Functions

 MVTime ()
 Default constructor: generate a zero value.
 MVTime (const MVTime &other)
 Copy constructor.
MVTimeoperator= (const MVTime &other)
 Copy assignment.
 MVTime (Double d)
 Constructor from Double (in MJD)
 MVTime (const Quantity &other)
 Constructor from Quantum : value can be an angle or time.
 MVTime (const Time &other)
 Constructor from Time.
 MVTime (const MVEpoch &other)
 Constructor from MVEpoch;.
 MVTime (Int yy, Int mm, Double dd, Double d=0.0)
 Constructor from yy, mm, dd, dd (all dd with fractions allowed)
 ~MVTime ()
 operator Double () const
 Conversion operator.
Double day () const
 Get value of date/time (MJD) in given units.
Double hour () const
Double minute () const
Double second () const
Quantity get () const
Quantity get (const Unit &inunit) const
Time getTime () const
const StringdayName () const
 Get indicated part of the time/date.
const StringmonthName () const
uInt weekday () const
 Mon = 1; Sun = 7;.
uInt month () const
 Jan =1.
uInt monthday () const
Int year () const
Int ymd () const
uInt yearday () const
uInt yearweek () const
String string () const
 Output data.
String string (MVTime::formatTypes intyp, uInt inprec=0) const
String string (uInt intyp, uInt inprec) const
String string (uInt inprec) const
String string (const MVTime::Format &form) const
void print (ostream &oss, const MVTime::Format &form) const

Static Public Member Functions

static Bool read (Quantity &res, const String &in)
 Make res time Quantity from string.
static Bool read (Quantity &res, MUString &in)
static Bool read (Quantity &res, const String &in, Bool chk)
static Bool read (Quantity &res, MUString &in, Bool chk)
static const StringdayName (uInt which)
static const StringmonthName (uInt which)
static Format setFormat (MVTime::formatTypes intyp, uInt inprec=0)
 Set default format
Warning: It is thread-unsafe to print using the setFormat functions because they change a static class member; The only thred-safe way to print a time is to use the print function above;

static Format setFormat (uInt intyp, uInt inprec)
static Format setFormat (uInt inprec=0)
static Format setFormat (const Format &form)
static Format getFormat ()
 Get default format.
static MVTime::formatTypes giveMe (const String &in)
 Get code belonging to string.
static Double timeZone ()
 Get time zone offset (in days)

Private Member Functions

void ymd (Int &yyyy, Int &mm, Int &dd) const
 Get the y,m,d values.

Private Attributes

Double val
 Value.

Static Private Attributes

static MVTime::Format defaultFormat
 Default format.
static MVTime::Format interimFormat
 Temporary format.
static Bool interimSet

Friends

ostream & operator<< (ostream &os, const MVTime &meas)
 Output a date/time.
istream & operator>> (istream &is, MVTime &meas)
 Input a date/time.
ostream & operator<< (ostream &os, const MVTime::Format &form)
 Set a temporary format.

Detailed Description

Class to handle date/time type conversions and I/O.

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

From Measure, Value and Time

Synopsis

An MVTime is a simple Double for date/time conversions and I/O. Its internal value is in MJD. For high precision the MVEpoch class should be used.
It can be constructed from a Double (in which case MJD are assumed), or from a Quantity (Quantum<Double>). Quantities must be in either angle or time units, or from a MVEpoch
The OS/Time class can be used as both input and output. An MVTime(Time) constructor exists, as well as a Time getTime().
Construction from year, month, day is also supported.
Caution: Dates before 16 Oct 1582 are considered to be Julian, rather than Gregorian
It has an automatic conversion to Double, so all standard mathematical operations can operate on it.
The class has a number of special functions to obtain data:

Output formatting is done with the << statement, with the following rules:

The default formatting can be overwritten by a MVTime::setFormat(); statement; which returns an MVTime::Format structure, that can be used in a subsequent one to reset to previous. The format set holds for all MVTime output on all streams.
Temporary formats (i.e. for one MVTime output only), can be set by outputting a format (i.e. stream << MVTime::Format() << ... ).
Caution: A setFormat() will also reset any lingering temporary format; A setFormat(getFormat()) will reset without changing; Problems could arise in parallel processors;
Input can be read if the values are in any of the above (non-clean) output formats.
For other formatting practice, the output can be written to a String with the string() member functions.
Note that using a temporary format is inherently thread-unsafe because the format is kept in a static variable. Another thread may overwrite the format just set. The only thread-safe way to format an MVTime is using a print or string that accepts a Format object.

Strings and input can be converted to an MVTime (or Quantity) by Bool read(Quantity &out, const String &in) and istream >> MVTime &. In the latter case the actual reading is done by the String read, which reads between white-spaces.
The following input formats (note no blanks allowed) are supported (+stands for an optional + or -; v for an unsigned integer; dv for a floating number. [] indicate optional values. Separating codes are case insensitive), numbers(like yyyy) can be of any length:

  • today -- (UT) time now
  • today/[time] -- time on today (0:0:0 if omitted)
  • yyyy/mm/dd[/time] -- date + time. An omitted date (leading /) will be today + time; an omitted month will indicate use of day number in year (1 == 1/1)
  • dd[-]MMM[-]yyyy[/time] -- date +time If yyyy <100: around 2000. MMM can be at least first three characters of month name; or a month number (1 == Jan). Omitted month indicates day is day number.
  • ccyy-mm-dd[Ttime[Z|+-hh[:mm]]] -- new FITS format the 'T' as time separator. Time should be UTC. The 'Z' separator (for UTC) is part of an earlier FITS proposal, and will be recognised for backward compatibility. A signed hh or hh:mm can be present to indicate time zone. This value will be subtracted to give UTC. To recognise this format, the year should be greater than 1000.
    Caution: The time-zone information is not part of the FITS standard, but of the underlying ISO standard;

The time can be expressed as described in MVAngle Examples of valid strings:

        ToDay           note case independence
        1996/11/20      20 November 1996 0h UT
        1996/11/20/5:20 20 November 1996 at 5h20m
        20Nov96-5h20m   same (again no case dependence)
        1996-11-20T5:20 same (FITS format, case dependent)

Example

See synopsis

Motivation

To be able to format date/time-like values in user-required ways.

To Do

  • Nothing I know of

Definition at line 258 of file MVTime.h.


Member Enumeration Documentation

Format types.

Enumerator:
ANGLE 
TIME 
CLEAN 
NO_D 
NO_DM 
YMD 
DMY 
DAY 
NO_TIME 
MJD 
DIG2 
FITS 
LOCAL 
NO_H 
NO_HM 
ANGLE_CLEAN 
ANGLE_NO_D 
ANGLE_NO_DM 
ANGLE_CLEAN_NO_D 
ANGLE_CLEAN_NO_DM 
TIME_CLEAN 
TIME_NO_H 
TIME_NO_HM 
TIME_CLEAN_NO_H 
TIME_CLEAN_NO_HM 
YMD_ONLY 
MOD_MASK 

Definition at line 264 of file MVTime.h.


Constructor & Destructor Documentation

Default constructor: generate a zero value.

casa::MVTime::MVTime ( const MVTime other)

Copy constructor.

Constructor from Double (in MJD)

casa::MVTime::MVTime ( const Quantity other)

Constructor from Quantum : value can be an angle or time.

Thrown Exceptions

casa::MVTime::MVTime ( const Time other)

Constructor from Time.

casa::MVTime::MVTime ( const MVEpoch other)

Constructor from MVEpoch;.

casa::MVTime::MVTime ( Int  yy,
Int  mm,
Double  dd,
Double  d = 0.0 
)

Constructor from yy, mm, dd, dd (all dd with fractions allowed)


Member Function Documentation

Get value of date/time (MJD) in given units.

const String& casa::MVTime::dayName ( ) const

Get indicated part of the time/date.

static const String& casa::MVTime::dayName ( uInt  which) [static]
Quantity casa::MVTime::get ( const Unit inunit) const
static Format casa::MVTime::getFormat ( ) [static]

Get default format.

static MVTime::formatTypes casa::MVTime::giveMe ( const String in) [static]

Get code belonging to string.

0 if not known

Jan =1.

const String& casa::MVTime::monthName ( ) const
static const String& casa::MVTime::monthName ( uInt  which) [static]
casa::MVTime::operator Double ( ) const

Conversion operator.

MVTime& casa::MVTime::operator= ( const MVTime other)

Copy assignment.

void casa::MVTime::print ( ostream &  oss,
const MVTime::Format form 
) const
static Bool casa::MVTime::read ( Quantity res,
const String in 
) [static]

Make res time Quantity from string.

The String version will accept a time/angle Quantity as well. The chk checks for eos

static Bool casa::MVTime::read ( Quantity res,
MUString in 
) [static]
static Bool casa::MVTime::read ( Quantity res,
const String in,
Bool  chk 
) [static]
static Bool casa::MVTime::read ( Quantity res,
MUString in,
Bool  chk 
) [static]
static Format casa::MVTime::setFormat ( MVTime::formatTypes  intyp,
uInt  inprec = 0 
) [static]

Set default format
Warning: It is thread-unsafe to print using the setFormat functions because they change a static class member; The only thred-safe way to print a time is to use the print function above;

static Format casa::MVTime::setFormat ( uInt  intyp,
uInt  inprec 
) [static]
static Format casa::MVTime::setFormat ( uInt  inprec = 0) [static]
static Format casa::MVTime::setFormat ( const Format form) [static]

Output data.


Warning: The first function below is thread-unsafe because it uses the result of the setFormat function which changes a static class member; The other functions are thread-safe because the format is directly given;

String casa::MVTime::string ( MVTime::formatTypes  intyp,
uInt  inprec = 0 
) const
String casa::MVTime::string ( uInt  intyp,
uInt  inprec 
) const
String casa::MVTime::string ( uInt  inprec) const
String casa::MVTime::string ( const MVTime::Format form) const
static Double casa::MVTime::timeZone ( ) [static]

Get time zone offset (in days)

Mon = 1; Sun = 7;.

void casa::MVTime::ymd ( Int yyyy,
Int mm,
Int dd 
) const [private]

Get the y,m,d values.


Friends And Related Function Documentation

ostream& operator<< ( ostream &  os,
const MVTime meas 
) [friend]

Output a date/time.

Output

ostream& operator<< ( ostream &  os,
const MVTime::Format form 
) [friend]

Set a temporary format.

istream& operator>> ( istream &  is,
MVTime meas 
) [friend]

Input a date/time.


Member Data Documentation

Default format.

Definition at line 424 of file MVTime.h.

Temporary format.

Definition at line 427 of file MVTime.h.

Bool casa::MVTime::interimSet [static, private]

Definition at line 428 of file MVTime.h.

Value.

Definition at line 422 of file MVTime.h.


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