datetime.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Kenneth Gangstoe
*/



#pragma once

#include "../api_core.h"
#include "../IOData/datatypes.h"

class CL_API_CORE CL_DateTime
{
public:
        enum TimeZone
        {
                local_timezone,
                utc_timezone
        };

        CL_DateTime();
        CL_DateTime(int year, int month, int day, int hour = 0, int minute = 0, int seconds = 0, int nanoseconds = 0, TimeZone timezone=utc_timezone);
        ~CL_DateTime();

        static CL_DateTime get_current_local_time();

        static CL_DateTime get_current_utc_time();

        static CL_DateTime get_local_time_from_ticks(cl_int64 ticks);

        static CL_DateTime get_utc_time_from_ticks(cl_int64 ticks);

        static CL_DateTime from_short_date_string(const CL_String &value);


public:
        bool is_null() const;
        unsigned short get_year() const;
        unsigned char get_month() const;
        unsigned char get_day() const;
        unsigned char get_hour() const;
        unsigned char get_minutes() const;
        unsigned char get_seconds() const;
        unsigned int get_nanoseconds() const;
        TimeZone get_timezone() const;

        unsigned int get_day_of_week() const;

public:
        void set_null();
        void set_date(int year, int month, int day, int hour = 0, int minute = 0, int seconds = 0, int nanoseconds = 0, TimeZone timezone = utc_timezone);
        void set_year(int year);
        void set_month(int month);
        void set_day(int day);
        void set_hour(int hour);
        void set_minutes(int minutes);
        void set_seconds(int seconds);
        void set_nanoseconds(int nanoseconds);
        void set_timezone(TimeZone timezone);
/*
        void add_years(int years);
        void add_days(int days);
        void add_months(int months);
        void add_hours(int hours);
        void add_minutes(int minutes);
        void add_seconds(int seconds);
        void add_nanoseconds(int nanoseconds);
*/
        CL_DateTime to_utc() const;
        CL_DateTime to_local() const;

        cl_int64 to_ticks() const;

        CL_String to_long_date_string() const;

        CL_String to_short_date_string() const;

        CL_String to_short_datetime_string() const;

        CL_String to_long_time_string() const;

        CL_String to_short_time_string() const;

        CL_String to_string() const;

        bool operator <(const CL_DateTime &other) const;
        bool operator <=(const CL_DateTime &other) const;
        bool operator >(const CL_DateTime &other) const;
        bool operator >=(const CL_DateTime &other) const;
        bool operator ==(const CL_DateTime &other) const;
        bool operator !=(const CL_DateTime &other) const;

private:
        void throw_if_invalid_date(int year, int month, int day, int hour, int minute, int seconds, int nanoseconds) const;
        void throw_if_null() const;

        unsigned short year;
        unsigned char month;
        unsigned char day;
        unsigned char hour;
        unsigned char minute;
        unsigned char seconds;
        unsigned int nanoseconds;

        TimeZone timezone;
        static const cl_int64 ticks_from_1601_to_1900;
};

---