ofstd/include/ofdate.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 date functions
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2004/01/16 10:30:39 $
 *  CVS/RCS Revision: $Revision: 1.6 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef OFDATE_H
#define OFDATE_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 */
#include "ofstream.h"      /* for ostream */


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

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


 public:

    OFDate();

    OFDate(const OFDate &dateVal);

    OFDate(const unsigned int year,
           const unsigned int month,
           const unsigned int day);

    virtual ~OFDate();

    virtual OFDate &operator=(const OFDate &dateVal);

    virtual OFBool operator==(const OFDate &dateVal) const;

    virtual OFBool operator!=(const OFDate &dateVal) const;

    virtual OFBool operator<(const OFDate &dateVal) const;

    virtual OFBool operator<=(const OFDate &dateVal) const;

    virtual OFBool operator>=(const OFDate &dateVal) const;

    virtual OFBool operator>(const OFDate &dateVal) const;

    virtual void clear();

    virtual OFBool isValid() const;

    OFBool setDate(const unsigned int year,
                   const unsigned int month,
                   const unsigned int day);

    OFBool setYear(const unsigned int year);

    OFBool setMonth(const unsigned int month);

    OFBool setDay(const unsigned int day);

    OFBool setCurrentDate();

    OFBool setISOFormattedDate(const OFString &formattedDate);

    unsigned int getYear() const;

    unsigned int getMonth() const;

    unsigned int getDay() const;

    OFBool getISOFormattedDate(OFString &formattedDate,
                               const OFBool showDelimiter = OFTrue) const;

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

    static OFDate getCurrentDate();


 protected:

    OFBool setCurrentDate(const time_t &tt);

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

    static OFBool isDateValid(const unsigned int year,
                              const unsigned int month,
                              const unsigned int day);


 private:

    unsigned int Year;

    unsigned int Month;

    unsigned int Day;
};


ostream& operator<<(ostream& stream, const OFDate &dateVal);


#endif


/*
 *
 * CVS/RCS Log:
 * $Log: ofdate.h,v $
 * Revision 1.6  2004/01/16 10:30:39  joergr
 * Added setISOFormattedXXX() methods for Date, Time and DateTime.
 *
 * 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  2003/07/04 13:30:37  meichel
 * Added include for ofstream.h, to make sure ofstream is correctly defined
 *
 * Revision 1.3  2002/05/24 09:43:04  joergr
 * Renamed some parameters/variables to avoid ambiguities.
 *
 * Revision 1.2  2002/04/15 09:38:58  joergr
 * Added "include <sys/types.h>" for struct time_t (required for MSVC).
 *
 * Revision 1.1  2002/04/11 12:12:23  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