dateinfo.h

Go to the documentation of this file.

#pragma once
/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Bril
 Date:          12-3-1996
________________________________________________________________________

-*/

#include "basicmod.h"
#include "enums.h"
#include "undefval.h"

mExpClass(Basic) DateInfo
{
public:
    enum DayOfWeek      { Su=0, Mo, Tu, We, Th, Fr, Sa };
                        mDeclareEnumUtils(DayOfWeek)
    enum Month          { Jan=0, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep,
                          Oct, Nov, Dec };
                        mDeclareEnumUtils(Month)        
    static const char** sFullMonths();          
    static const char** sAllDaysInMonth();      

                        DateInfo();             
                        DateInfo(int usryr,int usrmnth,int usrdy);
                        DateInfo(int usryr,Month,int usrdy);
                        DateInfo(int usryr,const char* mnth,int usrdy);
                        DateInfo(const char*);

    bool                isUdf() const           { return mIsUdf(days1900_); }
    void                setUdf(bool yn=true);

    int                 day() const             { return days_  + 1; }
    Month               month() const           { return (Month)months_; }
    int                 year() const            { return 1900 + years_; }
    int                 usrMonth() const        { return (int)months_ + 1; }
    void                setDay(int);
    void                setMonth(int);
    void                setMonth(Month);
    void                setYear(int);

    bool                operator ==(const DateInfo&) const;
    bool                operator !=(const DateInfo&) const;
    bool                operator <(const DateInfo&) const;
    bool                operator <=(const DateInfo&) const;
    bool                operator >(const DateInfo&) const;
    bool                operator >=(const DateInfo&) const;
    DateInfo&           operator +=(int);
    DateInfo&           operator -=( int dys )  { *this += -dys; return *this; }
    friend int          operator -(const DateInfo&,const DateInfo&);
    void                addMonths(int);

    int                 weekDay() const;        
    const char*         weekDayName() const;
    const char*         monthName() const   {return MonthDef().getKey(month());}
    const char*         whenRelative(const DateInfo* di=0) const;
    static const char*  fullMonthName(int);
    static const char*  fullMonthName(Month);
    const char*         fullMonthName() const  { return fullMonthName(month());}

    void                toString(BufferString&) const;
    bool                fromString(const char*);
    bool                fromStdDateString(const char*);
    bool                fromNumString(const char*,bool yearfirst);
    void                getUsrDisp(BufferString&,bool withcurtime) const;

    static int          daysInMonth(int yr,Month);
    static int          daysInYear( int yr )    { return yr%4 ? 365 : 366; }
    static Month        usrMonth2Month(int);

private:

    int                 days1900_;
    int                 years_;
    int                 months_;
    int                 days_;

    void                getDaysMonths(int,int,int&,int&);
    void                calcDMY();
    void                calcDays1900();
    void                getRel(const DateInfo&,BufferString&) const;
    void                getRelToday(BufferString&) const;
    void                addDay(BufferString&) const;

public:

    int                 key() const             { return days1900_; }
                        DateInfo(int the_key);

};


inline bool DateInfo::operator ==( const DateInfo& di ) const
{ return days1900_ == di.days1900_; }

inline bool DateInfo::operator !=( const DateInfo& di ) const
{ return days1900_ != di.days1900_; }

inline bool DateInfo::operator <( const DateInfo& di ) const
{ return days1900_ < di.days1900_; }

inline bool DateInfo::operator <=( const DateInfo& di ) const
{ return days1900_ <= di.days1900_; }

inline bool DateInfo::operator >( const DateInfo& di ) const
{ return days1900_ > di.days1900_; }

inline bool DateInfo::operator >=( const DateInfo& di ) const
{ return days1900_ >= di.days1900_; }

inline int operator -( const DateInfo& di1, const DateInfo& di2 )
{ return di1.days1900_ - di2.days1900_; }