ofstd/include/oftime.h

/*
 *
 *  Copyright (C) 2002-2004, OFFIS
 *
 *  This software and supporting documentation were developed by
 *
 *    Kuratorium OFFIS e.V.
 *    Healthcare Information and Communication Systems
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *  THIS SOFTWARE IS MADE AVAILABLE,  AS IS,  AND OFFIS MAKES NO  WARRANTY
 *  REGARDING  THE  SOFTWARE,  ITS  PERFORMANCE,  ITS  MERCHANTABILITY  OR
 *  FITNESS FOR ANY PARTICULAR USE, FREEDOM FROM ANY COMPUTER DISEASES  OR
 *  ITS CONFORMITY TO ANY SPECIFICATION. THE ENTIRE RISK AS TO QUALITY AND
 *  PERFORMANCE OF THE SOFTWARE IS WITH THE USER.
 *
 *  Module:  ofstd
 *
 *  Author:  Joerg Riesmeier
 *
 *  Purpose: Class for time functions
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2004/01/16 10:30:39 $
 *  CVS/RCS Revision: $Revision: 1.7 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef OFTIME_H
#define OFTIME_H

#include "osconfig.h"

BEGIN_EXTERN_C
#ifdef HAVE_SYS_TYPES_H
# include <sys/types.h>    /* for struct time_t */
#endif
END_EXTERN_C

#include "ofstring.h"      /* for class OFString */


/*---------------------*
 *  class declaration  *
 *---------------------*/

class OFTime
{
    // allow class OFDateTime to access protected class members
    friend class OFDateTime;


 public:

    OFTime();

    OFTime(const OFTime &timeVal);

    OFTime(const unsigned int hour,
           const unsigned int minute,
           const double second,
           const double timeZone = 0);

    virtual ~OFTime();

    virtual OFTime &operator=(const OFTime &timeVal);

    virtual OFBool operator==(const OFTime &timeVal) const;

    virtual OFBool operator!=(const OFTime &timeVal) const;

    virtual OFBool operator<(const OFTime &timeVal) const;

    virtual OFBool operator<=(const OFTime &timeVal) const;

    virtual OFBool operator>=(const OFTime &timeVal) const;

    virtual OFBool operator>(const OFTime &timeVal) const;

    virtual void clear();

    virtual OFBool isValid() const;

    OFBool setTime(const unsigned int hour,
                   const unsigned int minute,
                   const double second,
                   const double timeZone = 0);

    OFBool setHour(const unsigned int hour);

    OFBool setMinute(const unsigned int minute);

    OFBool setSecond(const double second);

    OFBool setTimeZone(const double timeZone);

    OFBool setTimeZone(const signed int hour,
                       const unsigned int minute);

    OFBool setTimeInSeconds(const double seconds,
                            const double timeZone = 0,
                            const OFBool normalize = OFTrue);

    OFBool setTimeInHours(const double hours,
                          const double timeZone = 0,
                          const OFBool normalize = OFTrue);

    OFBool setCurrentTime();

    OFBool setISOFormattedTime(const OFString &formattedTime);

    unsigned int getHour() const;

    unsigned int getMinute() const;

    double getSecond() const;

    unsigned int getIntSecond() const;

    unsigned int getMilliSecond() const;

    unsigned int getMicroSecond() const;

    double getTimeZone() const;

    double getTimeInSeconds(const OFBool useTimeZone = OFFalse,
                            const OFBool normalize = OFTrue) const;

    double getTimeInHours(const OFBool useTimeZone = OFFalse,
                          const OFBool normalize = OFTrue) const;

    OFTime getCoordinatedUniversalTime() const;

    OFTime getLocalTime() const;

    OFBool getISOFormattedTime(OFString &formattedTime,
                               const OFBool showSeconds = OFTrue,
                               const OFBool showFraction = OFFalse,
                               const OFBool showTimeZone = OFFalse,
                               const OFBool showDelimiter = OFTrue) const;

    /* --- static helper functions --- */

    static OFTime getCurrentTime();

    static double getLocalTimeZone();


 protected:

    OFBool setCurrentTime(const time_t &tt);

    /* --- static helper functions --- */

    static OFBool isTimeValid(const unsigned int hour,
                              const unsigned int minute,
                              const double second,
                              const double timeZone);

    static double getTimeInSeconds(const unsigned int hour,
                                   const unsigned int minute,
                                   const double second,
                                   const double timeZone = 0,
                                   const OFBool normalize = OFTrue);

    static double getTimeInHours(const unsigned int hour,
                                 const unsigned int minute,
                                 const double second,
                                 const double timeZone = 0,
                                 const OFBool normalize = OFTrue);


 private:

    unsigned int Hour;

    unsigned int Minute;

    double Second;

    double TimeZone;
};


ostream& operator<<(ostream& stream, const OFTime &timeVal);


#endif


/*
 *
 * CVS/RCS Log:
 * $Log: oftime.h,v $
 * Revision 1.7  2004/01/16 10:30:39  joergr
 * Added setISOFormattedXXX() methods for Date, Time and DateTime.
 *
 * Revision 1.6  2003/12/17 15:18:48  joergr
 * Fixed bug/inconsistency in comparison operators of class OFTime. Now the
 * "time overflow" is handled correctly.
 *
 * Revision 1.5  2003/09/15 12:12:56  joergr
 * Fixed incorrect/improper comments of the comparision operators. Enhanced
 * comment of the default constructor. Made comparison operators const.
 *
 * Revision 1.4  2002/05/24 09:43:05  joergr
 * Renamed some parameters/variables to avoid ambiguities.
 *
 * Revision 1.3  2002/04/19 10:42:51  joergr
 * Added new helper routines to get the milli and micro seconds part as well as
 * the integral value of seconds.
 *
 * Revision 1.2  2002/04/15 09:38:59  joergr
 * Added "include <sys/types.h>" for struct time_t (required for MSVC).
 *
 * Revision 1.1  2002/04/11 12:12:24  joergr
 * Introduced new standard classes providing date and time functions.
 *
 *
 */

---

Generated on 4 Nov 2004 for OFFIS DCMTK Version 3.5.3 by Doxygen 1.3.8