DateTime.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once


#include "WString.h"

BEGIN_BENTLEY_NAMESPACE


//=======================================================================================    
//=======================================================================================    
struct DateTime
{
public:
    //=======================================================================================    
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================    
    enum class Kind
        {
        Unspecified = 0,

        Utc = 1,

        Local = 2
        };

    //=======================================================================================    
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================    
    enum class Component
        {
        Date = 0,

        DateAndTime = 1,
        };

    //=======================================================================================    
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================    
    enum class DayOfWeek
        {
        Sunday = 0, 
        Monday = 1, 
        Tuesday = 2, 
        Wednesday = 3, 
        Thursday = 4, 
        Friday = 5, 
        Saturday = 6 
        };

    //=======================================================================================    
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================    
    enum class CompareResult
        {
        EarlierThan, 
        Equals, 
        LaterThan, 
        Error 
        };

    //=======================================================================================    
    // @bsiclass                                                     Bentley Systems
    //=======================================================================================    
    struct Info
        {
    private:
        Kind m_kind;
        Component m_component;

    public:
        //***** Construction ******

        BENTLEYDLL_EXPORT Info ();

        BENTLEYDLL_EXPORT Info (Kind kind, Component component);

        BENTLEYDLL_EXPORT bool operator== (Info const& rhs) const;

        BENTLEYDLL_EXPORT bool operator!= (Info const& rhs) const;

        BENTLEYDLL_EXPORT Kind GetKind () const;

        BENTLEYDLL_EXPORT Component GetComponent () const;

        BENTLEYDLL_EXPORT static WString KindToString (DateTime::Kind kind);

        BENTLEYDLL_EXPORT static WString ComponentToString (DateTime::Component component);
        };

private:
    Info m_info;
    Int16 m_year;
    UInt8 m_month;
    UInt8 m_day;
    UInt8 m_hour;
    UInt8 m_minute;
    UInt8 m_second;
    UInt32 m_hectoNanosecond;

public:
    //***** Construction ******

    BENTLEYDLL_EXPORT DateTime ();

    BENTLEYDLL_EXPORT DateTime (Int16 year, UInt8 month, UInt8 day);

    BENTLEYDLL_EXPORT DateTime (Kind kind, Int16 year, UInt8 month, UInt8 day, UInt8 hour, UInt8 minute, UInt8 second = 0, UInt32 hectoNanosecond = 0);
    
    BENTLEYDLL_EXPORT bool IsValid () const;


    bool operator== (DateTime const& rhs) const { return Equals (rhs, false); }

    bool operator!= (DateTime const& rhs) const { return !(*this == rhs); }

    BENTLEYDLL_EXPORT bool Equals (DateTime const& rhs, bool ignoreDateTimeInfo = false) const;

    BENTLEYDLL_EXPORT static CompareResult Compare (DateTime const& lhs, DateTime const& rhs);


    BENTLEYDLL_EXPORT static DateTime GetCurrentTime ();

    BENTLEYDLL_EXPORT static DateTime GetCurrentTimeUtc ();
    


    BENTLEYDLL_EXPORT BentleyStatus ToJulianDay (UInt64& julianDayInHns) const;

    BENTLEYDLL_EXPORT BentleyStatus ToJulianDay (double& julianDay) const;

    BENTLEYDLL_EXPORT static BentleyStatus FromJulianDay (DateTime& dateTime, UInt64 julianDayInHns, Info const& targetInfo);

    BENTLEYDLL_EXPORT static BentleyStatus FromJulianDay (DateTime& dateTime, double julianDay, Info const& targetInfo);



    BENTLEYDLL_EXPORT BentleyStatus ToUtc (DateTime& utcDateTime) const;

    BENTLEYDLL_EXPORT BentleyStatus ToLocalTime (DateTime& localDateTime) const;

    BENTLEYDLL_EXPORT BentleyStatus ToUnixMilliseconds (Int64& unixMilliseconds) const;

    BENTLEYDLL_EXPORT static BentleyStatus FromUnixMilliseconds (DateTime& dateTime, UInt64 unixMilliseconds);
    
    BENTLEYDLL_EXPORT static Int64 JulianDayToUnixMilliseconds (UInt64 julianDayInHectoNanoseconds);
    
    BENTLEYDLL_EXPORT static UInt64 UnixMillisecondsToJulianDay (UInt64 unixMilliseconds);

    BENTLEYDLL_EXPORT BentleyStatus ToCommonEraTicks (Int64& commonEraTicks) const;

    BENTLEYDLL_EXPORT static BentleyStatus FromCommonEraTicks (DateTime& dateTime, Int64 commonEraTicks, Info const& targetInfo);

    BENTLEYDLL_EXPORT static Int64 JulianDayToCommonEraTicks (UInt64 julianDayInHectoNanoseconds);

    BENTLEYDLL_EXPORT static UInt64 CommonEraTicksToJulianDay (Int64 commonEraTicks);



    BENTLEYDLL_EXPORT Utf8String ToUtf8String () const;

    WString ToString () const
        {
        return WString (ToUtf8String ().c_str (), BentleyCharEncoding::Utf8);
        }
    
    BENTLEYDLL_EXPORT static BentleyStatus FromString (DateTime& dateTime, Utf8CP dateTimeIso8601);

    BENTLEYDLL_EXPORT static BentleyStatus FromString (DateTime& dateTime, WCharCP dateTimeIso8601);


    BENTLEYDLL_EXPORT Info const& GetInfo () const;


    BENTLEYDLL_EXPORT Int16 GetYear () const;

    BENTLEYDLL_EXPORT UInt8 GetMonth () const;

    BENTLEYDLL_EXPORT UInt8 GetDay () const;

    BENTLEYDLL_EXPORT UInt8 GetHour () const;

    BENTLEYDLL_EXPORT UInt8 GetMinute () const;

    BENTLEYDLL_EXPORT UInt8 GetSecond () const;   

    BENTLEYDLL_EXPORT UInt16 GetMillisecond () const;

    BENTLEYDLL_EXPORT UInt32 GetHectoNanosecond () const;

    BENTLEYDLL_EXPORT DayOfWeek GetDayOfWeek () const;

    BENTLEYDLL_EXPORT UInt16 GetDayOfYear () const;

    BENTLEYDLL_EXPORT static bool IsLeapYear (UInt16 year);

    BENTLEYDLL_EXPORT BentleyStatus ComputeOffsetToUtcInHns(Int64& offset) const;

    };

//Convenience typedefs for the DateTime type
typedef DateTime& DateTimeR;
typedef DateTime const& DateTimeCR;
typedef DateTime* DateTimeP;
typedef DateTime const* DateTimeCP;


END_BENTLEY_NAMESPACE