RTTimeSpan.h

//                                                                             //
// <copyright company="Objectis">                                              //
//                                                                             //
// Copyright (c) 2013, All Right Reserved, http://www.objectis.ch/             //
//                                                                             //
// This source is subject to the Objectis Permissive License.                  //
// Please see the License contract for more information.                       //      
// All other rights reserved.                                                  //
//                                                                             //
// THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY      //
// KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE         //
// IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A                  //
// PARTICULAR PURPOSE.                                                         //
//                                                                             //
// </copyright>                                                                //
//                                                                             //

#ifndef __RT_TIMESPAN_H_
#define __RT_TIMESPAN_H_

#include "RTString.h"

namespace ConceptRT
{
    class CONCEPTRT_API TimeSpan : public IStringConvertible
    {
        RT_DYNAMIC_CAST_1(TimeSpan, IStringConvertible)
    public:

        TimeSpan();

        explicit TimeSpan(TimeStamp timeStamp);

        explicit TimeSpan(const String& text);

        TimeSpan(Int32 day, Int32 hour, Int32 minute, Int32 second, 
            Int32 millisecond = 0, Int32 microsecond = 0);

        void SetTimeSpan(Int32 day, Int32 hour, Int32 minute, Int32 second, Int32 millisecond = 0, Int32 microsecond = 0);

        void GetTimeSpan(Int32 & day, Int32 & hour, Int32 & minute, Int32 & second, 
            Int32 & millisecond, Int32 & microsecond) const;

        Int32 GetDay() const;

        Int32 GetHour() const;

        Int32 GetMinute() const;

        Int32 GetSecond() const;

        Int32 GetMillisecond() const;

        Int32 GetMicrosecond() const;

        // IStringConvertible override
        void ConvertFrom(PCChar8 text) override;
        void ConvertTo(BaseStaticString& text) const override;

        TimeStamp ToTimeStamp() const;

        TimeSpan & operator+=(const TimeSpan & right);

        TimeSpan & operator-=(const TimeSpan & right);

        Int32 ToSeconds() const;

        Int32 ToMilliseconds() const;

        Int32 ToMicroseconds() const;

    private:
        TimeStamp _timeStamp;
        TimeStamp Encode(Int32 day, Int32 hour, Int32 minute, Int32 second, Int32 millisecond, Int32 microsecond) const;
        void Decode(TimeStamp timeSpan, Int32 & day, Int32 & hour, Int32 & minute, Int32 & second, 
                             Int32 & millisecond, Int32 & microsecond) const;
    };

    TimeSpan CONCEPTRT_API Weeks(Int32 value); 

    TimeSpan CONCEPTRT_API Days(Int32 value); 

    TimeSpan CONCEPTRT_API Hours(Int32 value); 

    TimeSpan CONCEPTRT_API Minutes(Int32 value); 

    TimeSpan CONCEPTRT_API Seconds(Int32 value); 

    TimeSpan CONCEPTRT_API Milliseconds(Int32 value);

    TimeSpan CONCEPTRT_API Microseconds(Int32 value); 

    TimeSpan CONCEPTRT_API operator-(const TimeSpan & left);

    TimeSpan CONCEPTRT_API operator+(const TimeSpan & left, const TimeSpan & right);

    TimeSpan CONCEPTRT_API operator-(const TimeSpan & left, const TimeSpan & right);

    bool CONCEPTRT_API operator<(const TimeSpan & left, const TimeSpan & right);

    bool CONCEPTRT_API operator>(const TimeSpan & left, const TimeSpan & right);

    bool CONCEPTRT_API operator==(const TimeSpan & left, const TimeSpan & right);

    bool CONCEPTRT_API operator<=(const TimeSpan & left, const TimeSpan & right);

    bool CONCEPTRT_API operator>=(const TimeSpan & left, const TimeSpan & right);

    bool CONCEPTRT_API operator!=(const TimeSpan & left, const TimeSpan & right);

    extern const TimeSpan CONCEPTRT_API TimeInfinite;
    extern const TimeSpan CONCEPTRT_API TimeZero;

    extern const PCChar8 CONCEPTRT_API TextTimeSpanInfinite;

    enum DayPerYearConst                { DayPerYear = 365                          };
    enum MonthPerYearConst              { MonthPerYear = 12                         };
    enum DayPerWeekConst                { DayPerWeek = 7                            };
    enum HourPerDayConst                { HourPerDay = 24                           };
    enum MinutePerHourConst             { MinutePerHour = 60                    };
    enum SecondPerMinuteConst           { SecondPerMinute = 60                  };
    enum MillisecondPerSecondConst      { MillisecondPerSecond = 1000               };
    enum MicrosecondPerMillisecondConst { MicrosecondPerMillisecond = 1000          };
    enum TickPerMicrosecondConst        { TickPerMicrosecond = 10           };
}
#endif