itkRealTimeInterval.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkRealTimeInterval_h
#define itkRealTimeInterval_h
 
#include "itkIntTypes.h"
#include "itkMacro.h"
#include <iostream>
 
namespace itk
{
 
class ITKCommon_EXPORT RealTimeInterval
{
public:
  using Self = RealTimeInterval;

  using SecondsDifferenceType = int64_t;
  using MicroSecondsDifferenceType = int64_t;

  RealTimeInterval();

  RealTimeInterval(SecondsDifferenceType, MicroSecondsDifferenceType);

  using TimeRepresentationType = double;

  [[nodiscard]] TimeRepresentationType
  GetTimeInMicroSeconds() const;
  [[nodiscard]] TimeRepresentationType
  GetTimeInMilliSeconds() const;
  [[nodiscard]] TimeRepresentationType
  GetTimeInSeconds() const;
  [[nodiscard]] TimeRepresentationType
  GetTimeInMinutes() const;
  [[nodiscard]] TimeRepresentationType
  GetTimeInHours() const;
  [[nodiscard]] TimeRepresentationType
  GetTimeInDays() const;
  Self
  operator-(const Self &) const;
  Self
  operator+(const Self &) const;
  const Self &
  operator-=(const Self &);
  const Self &
  operator+=(const Self &);
  bool
  operator>(const Self &) const;
  bool
  operator<(const Self &) const;
  bool
  operator==(const Self &) const;
  ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION(Self);
  bool
  operator<=(const Self &) const;
  bool
  operator>=(const Self &) const;
  void Set(SecondsDifferenceType, MicroSecondsDifferenceType);

  friend ITKCommon_EXPORT std::ostream &
                          operator<<(std::ostream & os, const RealTimeInterval & v);
 
private:
  friend class RealTimeStamp;

  SecondsDifferenceType m_Seconds;

  MicroSecondsDifferenceType m_MicroSeconds;
};
 
} // end of namespace itk
 
#endif // itkRealTimeInterval_h