xstimestamp.h

Go to the documentation of this file.

 
//  Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
//  All rights reserved.
//  
//  Redistribution and use in source and binary forms, with or without modification,
//  are permitted provided that the following conditions are met:
//  
//  1.  Redistributions of source code must retain the above copyright notice,
//      this list of conditions, and the following disclaimer.
//  
//  2.  Redistributions in binary form must reproduce the above copyright notice,
//      this list of conditions, and the following disclaimer in the documentation
//      and/or other materials provided with the distribution.
//  
//  3.  Neither the names of the copyright holders nor the names of their contributors
//      may be used to endorse or promote products derived from this software without
//      specific prior written permission.
//  
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
//  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
//  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
//  THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
//  OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
//  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
//  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS 
//  SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES 
//  OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE 
//  ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
//  
 
 
//  Copyright (c) 2003-2021 Xsens Technologies B.V. or subsidiaries worldwide.
//  All rights reserved.
//  
//  Redistribution and use in source and binary forms, with or without modification,
//  are permitted provided that the following conditions are met:
//  
//  1.  Redistributions of source code must retain the above copyright notice,
//      this list of conditions, and the following disclaimer.
//  
//  2.  Redistributions in binary form must reproduce the above copyright notice,
//      this list of conditions, and the following disclaimer in the documentation
//      and/or other materials provided with the distribution.
//  
//  3.  Neither the names of the copyright holders nor the names of their contributors
//      may be used to endorse or promote products derived from this software without
//      specific prior written permission.
//  
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
//  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
//  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
//  THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
//  OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
//  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY OR
//  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.THE LAWS OF THE NETHERLANDS 
//  SHALL BE EXCLUSIVELY APPLICABLE AND ANY DISPUTES SHALL BE FINALLY SETTLED UNDER THE RULES 
//  OF ARBITRATION OF THE INTERNATIONAL CHAMBER OF COMMERCE IN THE HAGUE BY ONE OR MORE 
//  ARBITRATORS APPOINTED IN ACCORDANCE WITH SAID RULES.
//  
 
#ifndef XSTIMESTAMP_H
#define XSTIMESTAMP_H
 
#include "xstypesconfig.h"
#include "pstdint.h"
 
#ifdef __cplusplus
#ifndef XSENS_NO_STL
        #include "xsstring.h"
#endif
#include "xstimeinfo.h"
extern "C" {
#endif
#ifndef __cplusplus
#define XSTIMESTAMP_INITIALIZER { 0 }
#endif
 
struct XsTimeStamp;
struct XsTimeInfo;
struct XsString;
 
XSTYPES_DLL_API void XsTimeStamp_setMilliSecondTime(struct XsTimeStamp* thisPtr, int64_t t);
XSTYPES_DLL_API double XsTimeStamp_timeOfDay(const struct XsTimeStamp* thisPtr);
XSTYPES_DLL_API int64_t XsTimeStamp_secondTime(const struct XsTimeStamp* thisPtr);
XSTYPES_DLL_API int32_t XsTimeStamp_milliSecondPart(const struct XsTimeStamp* thisPtr);
XSTYPES_DLL_API int32_t XsTimeStamp_secondPart(const struct XsTimeStamp* thisPtr);
XSTYPES_DLL_API int32_t XsTimeStamp_minutePart(const struct XsTimeStamp* thisPtr);
XSTYPES_DLL_API int32_t XsTimeStamp_hourPart(const struct XsTimeStamp* thisPtr);
XSTYPES_DLL_API int64_t XsTimeStamp_now(struct XsTimeStamp* thisPtr);
XSTYPES_DLL_API int64_t XsTimeStamp_maxValue(void);
 
XSTYPES_DLL_API int64_t XsTimeStamp_fromTimeInfo(struct XsTimeStamp* thisPtr, const struct XsTimeInfo* info);
XSTYPES_DLL_API void XsTimeStamp_toTimeInfo(struct XsTimeStamp const* thisPtr, struct XsTimeInfo* info);
#ifndef XSENS_NO_STL
XSTYPES_DLL_API void XsTimeStamp_toString(struct XsTimeStamp const* thisPtr, struct XsString* result);
#endif
XSTYPES_DLL_API void XsTimeStamp_utcToLocalTime(struct XsTimeStamp const* thisPtr, struct XsTimeStamp* local);
XSTYPES_DLL_API void XsTimeStamp_localToUtcTime(struct XsTimeStamp const* thisPtr, struct XsTimeStamp* utc);
XSTYPES_DLL_API void XsTimeStamp_utcToLocalTime2(struct XsTimeStamp const* thisPtr, struct XsTimeStamp* local, const struct XsTimeInfo* info);
XSTYPES_DLL_API void XsTimeStamp_localToUtcTime2(struct XsTimeStamp const* thisPtr, struct XsTimeStamp* utc, const struct XsTimeInfo* info);
XSTYPES_DLL_API void XsTimeStamp_utcToLocalTime_ms(struct XsTimeStamp const* thisPtr, struct XsTimeStamp* local, int64_t utcOffset);
XSTYPES_DLL_API void XsTimeStamp_localToUtcTime_ms(struct XsTimeStamp const* thisPtr, struct XsTimeStamp* utc, int64_t utcOffset);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
struct XsTimeStamp
{
#ifdef __cplusplus
 
        inline XsTimeStamp(int64_t t = 0) : m_msTime(t) {}
 
        inline XsTimeStamp(int t) : m_msTime(t) {}
 
        inline explicit XsTimeStamp(double t) : m_msTime((int64_t)(t * 1000.0)) {}
 
        inline XsTimeStamp(const XsTimeStamp& other) : m_msTime(other.m_msTime) {}
 
        inline XsTimeStamp(const XsTimeInfo& info)
        {
                XsTimeStamp_fromTimeInfo(this, &info);
        }
 
        inline XsTimeInfo toTimeInfo() const
        {
                XsTimeInfo info;
                XsTimeStamp_toTimeInfo(this, &info);
                return info;
        }
 
        inline void toTimeInfo(XsTimeInfo& info) const
        {
                XsTimeStamp_toTimeInfo(this, &info);
        }
 
#ifndef XSENS_NO_STL
 
        inline XsString toString() const
        {
                XsString result;
                XsTimeStamp_toString(this, &result);
                return result;
        }
#endif
 
        inline XsTimeStamp& operator = (const XsTimeStamp& other)
        {
                m_msTime = other.m_msTime;
                return *this;
        }
 
        inline int64_t msTime(void) const
        {
                return m_msTime;
        }
 
        inline void setMsTime(int64_t t)
        {
                m_msTime = t;
        }
 
        inline double timeOfDay() const
        {
                return XsTimeStamp_timeOfDay(this);
        }
 
        inline int64_t msTimeOfDay() const
        {
                return m_msTime % (24 * 60 * 60 * 1000);
        }
 
        inline double secTime() const
        {
                return ((double)m_msTime) * 0.001;
        }
 
        inline void setSecTime(double t)
        {
                m_msTime = (int64_t)(t * 1000.0);
        }
 
        inline XsTimeStamp operator + (const XsTimeStamp& other) const
        {
                return XsTimeStamp(m_msTime + other.m_msTime);
        }
 
        inline XsTimeStamp operator - (const XsTimeStamp& other) const
        {
                return XsTimeStamp(m_msTime - other.m_msTime);
        }
 
        inline XsTimeStamp& operator += (const XsTimeStamp& other)
        {
                m_msTime += other.m_msTime;
                return *this;
        }
 
        inline XsTimeStamp& operator -= (const XsTimeStamp& d)
        {
                m_msTime -= d.m_msTime;
                return *this;
        }
 
        inline bool operator < (const XsTimeStamp& other) const
        {
                return m_msTime <  other.m_msTime;
        }
 
        inline bool operator <= (const XsTimeStamp& other) const
        {
                return m_msTime <= other.m_msTime;
        }
 
        inline bool operator == (const XsTimeStamp& other) const
        {
                return m_msTime == other.m_msTime;
        }
 
        inline bool operator > (const XsTimeStamp& other) const
        {
                return m_msTime >  other.m_msTime;
        }
 
        inline bool operator >= (const XsTimeStamp& other) const
        {
                return m_msTime >= other.m_msTime;
        }
 
        inline bool operator != (const XsTimeStamp& other) const
        {
                return m_msTime != other.m_msTime;
        }
 
        inline bool operator < (int other) const
        {
                return m_msTime <  other;
        }
 
        inline bool operator <= (int other) const
        {
                return m_msTime <= other;
        }
 
        inline bool operator == (int other) const
        {
                return m_msTime == other;
        }
 
        inline bool operator > (int other) const
        {
                return m_msTime >  other;
        }
 
        inline bool operator >= (int other) const
        {
                return m_msTime >= other;
        }
 
        inline bool operator != (int other) const
        {
                return m_msTime != other;
        }
 
        inline int64_t secondTime() const
        {
                return m_msTime / 1000;
        }
 
        inline int32_t milliSecondPart() const
        {
                return (int32_t)(m_msTime % 1000);
        }
 
        inline int32_t secondPart() const
        {
                return (int32_t)((m_msTime / (1000)) % 60);
        }
 
        inline int32_t minutePart() const
        {
                return (int32_t)((m_msTime / (60 * 1000)) % 60);
        }
 
        inline int32_t hourPart() const
        {
                return (int32_t)((m_msTime / (60 * 60 * 1000)) % 24);
        }
 
        inline static XsTimeStamp now()
        {
                XsTimeStamp tmp;
                XsTimeStamp_now(&tmp);
                return tmp;
        }
 
        inline static int64_t nowMs()
        {
                XsTimeStamp tmp;
                XsTimeStamp_now(&tmp);
                return tmp.msTime();
        }
 
        inline int64_t elapsedToNow() const
        {
                return XsTimeStamp_now(0) - m_msTime;
        }
 
        inline static XsTimeStamp maxValue()
        {
                return XsTimeStamp(int64_t(9223372036854775807LL));     //INT64_MAX
        }
 
        XsTimeStamp& operator++()
        {
                ++m_msTime;
                return *this;
        }
 
        XsTimeStamp operator++(int)
        {
                return XsTimeStamp(m_msTime++);
        }
 
        XsTimeStamp& operator--()
        {
                --m_msTime;
                return *this;
        }
 
        XsTimeStamp operator--(int)
        {
                return XsTimeStamp(m_msTime--);
        }
 
        XsTimeStamp utcToLocalTime() const
        {
                XsTimeStamp local;
                XsTimeStamp_utcToLocalTime(this, &local);
                return local;
        }
 
        XsTimeStamp localToUtcTime() const
        {
                XsTimeStamp utc;
                XsTimeStamp_localToUtcTime(this, &utc);
                return utc;
        }
 
        XsTimeStamp utcToLocalTime(XsTimeInfo const& info) const
        {
                XsTimeStamp local;
                XsTimeStamp_utcToLocalTime2(this, &local, &info);
                return local;
        }
 
        XsTimeStamp localToUtcTime(XsTimeInfo const& info) const
        {
                XsTimeStamp utc;
                XsTimeStamp_localToUtcTime2(this, &utc, &info);
                return utc;
        }
 
        XsTimeStamp utcToLocalTime(int64_t utcOffset) const
        {
                XsTimeStamp local;
                XsTimeStamp_utcToLocalTime_ms(this, &local, utcOffset);
                return local;
        }
 
        XsTimeStamp localToUtcTime(int64_t utcOffset) const
        {
                XsTimeStamp utc;
                XsTimeStamp_localToUtcTime_ms(this, &utc, utcOffset);
                return utc;
        }
private:
#endif
 
        int64_t m_msTime;               
};
 
typedef struct XsTimeStamp XsTimeStamp;
 
#endif