TimeBase.h

Go to the documentation of this file.

// this is for emacs file handling -*- mode: c++; indent-tabs-mode: nil -*-

// -- BEGIN LICENSE BLOCK ----------------------------------------------
// This file is part of FZIs ic_workspace.
//
// This program is free software licensed under the LGPL
// (GNU LESSER GENERAL PUBLIC LICENSE Version 3).
// You can find a copy of this license in LICENSE folder in the top
// directory of the source code.
//
// © Copyright 2016 FZI Forschungszentrum Informatik, Karlsruhe, Germany
//
// -- END LICENSE BLOCK ------------------------------------------------

//----------------------------------------------------------------------
//----------------------------------------------------------------------
#ifndef ICL_CORE_TIME_BASE_H_INCLUDED
#define ICL_CORE_TIME_BASE_H_INCLUDED

#include "icl_core/BaseTypes.h"
#include "icl_core/ImportExport.h"
#include "icl_core/os.h"

#ifdef _IC_BUILDER_HAS_TIME_H_
# include <time.h>
#endif
#ifdef _IC_BUILDER_HAS_SYS_TIME_H_
# include <sys/time.h>
#endif

#ifdef _SYSTEM_DARWIN_
# include <mach/clock_types.h>
#endif

#ifdef _IC_BUILDER_DEPRECATED_STYLE_
# include "icl_core/Deprecate.h"
#endif

namespace icl_core {


class ICL_CORE_IMPORT_EXPORT TimeBase
{
public:
  TimeBase& operator += (const TimeBase& span);

  TimeBase& operator -= (const TimeBase& span);

  bool operator != (const TimeBase& other) const;

  bool operator == (const TimeBase& other) const;

  bool operator < (const TimeBase& other) const;

  bool operator > (const TimeBase& other) const;

  bool operator <= (const TimeBase& other) const;

  bool operator >= (const TimeBase& other) const;

  void normalizeTime();

  int64_t days() const
  {
    return secs / 86400;
  }

  int64_t hours() const
  {
    return secs / 3600 % 24;
  }

  int64_t minutes() const
  {
    return (secs % 3600) / 60;
  }

  int64_t seconds() const
  {
    return (secs % 3600) % 60;
  }

  int32_t milliSeconds() const
  {
    return nsecs / 1000000;
  }

  int32_t microSeconds() const
  {
    return nsecs / 1000;
  }

  int32_t nanoSeconds() const
  {
    return nsecs % 1000;
  }

  int64_t tbSec() const { return secs; }
  int32_t tbNSec() const { return nsecs; }

  struct timespec timespec() const;

  struct timespec systemTimespec() const;

#ifdef _SYSTEM_DARWIN_
  mach_timespec_t machTimespec() const;
#endif

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  ICL_CORE_VC_DEPRECATE_STYLE void NormalizeTime() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int64_t Days() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int64_t Hours() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int64_t Minutes() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int64_t Seconds() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int32_t MilliSeconds() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int32_t MicroSeconds() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int32_t NanoSeconds() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE int64_t TbSec() const ICL_CORE_GCC_DEPRECATE_STYLE;
  ICL_CORE_VC_DEPRECATE_STYLE int32_t TbNSec() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE struct timespec Timespec() const ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE struct timespec SystemTimespec() const ICL_CORE_GCC_DEPRECATE_STYLE;

#ifdef _SYSTEM_DARWIN_

  ICL_CORE_VC_DEPRECATE_STYLE mach_timespec_t MachTimespec() const ICL_CORE_GCC_DEPRECATE_STYLE;
#endif

#endif

protected:

  static TimeBase maxTime();

  explicit TimeBase(int64_t secs=0, int32_t nsecs=0);

  TimeBase(const struct timespec& time);

  void fromTimespec(const struct timespec& time);

#ifdef _IC_BUILDER_DEPRECATED_STYLE_

  static ICL_CORE_VC_DEPRECATE_STYLE TimeBase MaxTime() ICL_CORE_GCC_DEPRECATE_STYLE;

  ICL_CORE_VC_DEPRECATE_STYLE void FromTimespec(const struct timespec& time) ICL_CORE_GCC_DEPRECATE_STYLE;

#endif

  int64_t secs;
  int32_t nsecs;
};

}

#endif