ofstd/include/dcmtk/ofstd/ofdatime.h

/*
 *
 *  Copyright (C) 2002-2010, OFFIS e.V.
 *  All rights reserved.  See COPYRIGHT file for details.
 *
 *  This software and supporting documentation were developed by
 *
 *    OFFIS e.V.
 *    R&D Division Health
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *
 *  Module:  ofstd
 *
 *  Author:  Joerg Riesmeier
 *
 *  Purpose: Combined class for date and time functions
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:15:50 $
 *  CVS/RCS Revision: $Revision: 1.10 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef OFDATIME_H
#define OFDATIME_H

#include "dcmtk/config/osconfig.h"

#include "dcmtk/ofstd/ofstring.h"   /* for class OFString */
#include "dcmtk/ofstd/ofdate.h"     /* for class OFDate */
#include "dcmtk/ofstd/oftime.h"     /* for class OFTime */


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

class OFDateTime
{

 public:

    OFDateTime();

    OFDateTime(const OFDateTime &dateTime);

    OFDateTime(const OFDate &dateVal,
               const OFTime &timeVal);

    OFDateTime(const unsigned int year,
               const unsigned int month,
               const unsigned int day,
               const unsigned int hour,
               const unsigned int minute,
               const double second,
               const double timeZone = 0);

    virtual ~OFDateTime();

    virtual OFDateTime &operator=(const OFDateTime &dateTime);

    virtual OFBool operator==(const OFDateTime &dateTime) const;

    virtual OFBool operator!=(const OFDateTime &dateTime) const;

    virtual void clear();

    virtual OFBool isValid() const;

    OFBool setDateTime(const unsigned int year,
                       const unsigned int month,
                       const unsigned int day,
                       const unsigned int hour,
                       const unsigned int minute,
                       const double second,
                       const double timeZone = 0);

    OFBool setDate(const OFDate &dateVal);

    OFBool setTime(const OFTime &timeVal);

    OFBool setDateTime(const OFDate &dateVal,
                       const OFTime &timeVal);

    OFBool setCurrentDateTime();

    OFBool setISOFormattedDateTime(const OFString &formattedDateTime);

    const OFDate &getDate() const;

    const OFTime &getTime() const;

    OFBool getISOFormattedDateTime(OFString &formattedDateTime,
                                   const OFBool showSeconds = OFTrue,
                                   const OFBool showFraction = OFFalse,
                                   const OFBool showTimeZone = OFFalse,
                                   const OFBool showDelimiter = OFTrue) const;

    OFBool getISOFormattedDateTime(OFString &formattedDateTime,
                                   const OFBool showSeconds /*= OFTrue*/,
                                   const OFBool showFraction /*= OFFalse*/,
                                   const OFBool showTimeZone /*= OFFalse*/,
                                   const OFBool showDelimiter /*= OFTrue*/,
                                   const OFString &dateTimeSeparator /*= " "*/) const;

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

    static OFDateTime getCurrentDateTime();


 private:

    OFDate Date;

    OFTime Time;
};


STD_NAMESPACE ostream& operator<<(STD_NAMESPACE ostream& stream, const OFDateTime &dateTime);


#endif


/*
 *
 * CVS/RCS Log:
 * $Log: ofdatime.h,v $
 * Revision 1.10  2010-10-14 13:15:50  joergr
 * Updated copyright header. Added reference to COPYRIGHT file.
 *
 * Revision 1.9  2008-05-21 16:31:22  joergr
 * Added new constructor and new setDateTime() method.
 *
 * Revision 1.8  2006/08/14 16:42:26  meichel
 * Updated all code in module ofstd to correctly compile if the standard
 *   namespace has not included into the global one with a "using" directive.
 *
 * Revision 1.7  2005/12/08 16:05:55  meichel
 * Changed include path schema for all DCMTK header files
 *
 * Revision 1.6  2004/04/16 12:43:26  joergr
 * Restructured code to avoid default parameter values for "complex types" like
 * OFString. Required for Sun CC 2.0.1.
 *
 * Revision 1.5  2004/01/16 10:30:39  joergr
 * Added setISOFormattedXXX() methods for Date, Time and DateTime.
 *
 * Revision 1.4  2003/12/17 15:16:20  joergr
 * Added note to the comparison operators that the "day overflow" is not yet
 * handled correctly.
 *
 * Revision 1.3  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.2  2002/05/24 09:43:04  joergr
 * Renamed some parameters/variables to avoid ambiguities.
 *
 * Revision 1.1  2002/04/11 12:12:23  joergr
 * Introduced new standard classes providing date and time functions.
 *
 *
 */

---

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1