itkRealTimeStamp.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  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
 *
 *         http://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 itkRealTimeStamp_h
#define itkRealTimeStamp_h

#include "itkRealTimeInterval.h"
#include "itkMacro.h"
#include <iostream>

namespace itk
{
class ITKCommon_EXPORT RealTimeStamp
{
public:

  using Self = RealTimeStamp;

  friend class RealTimeClock;

  RealTimeStamp();

  ~RealTimeStamp();

  using TimeRepresentationType = RealTimeInterval::TimeRepresentationType;

  TimeRepresentationType GetTimeInMicroSeconds() const;
  TimeRepresentationType GetTimeInMilliSeconds() const;
  TimeRepresentationType GetTimeInSeconds() const;
  TimeRepresentationType GetTimeInMinutes() const;
  TimeRepresentationType GetTimeInHours() const;
  TimeRepresentationType GetTimeInDays() const;

  RealTimeInterval operator-( const Self & ) const;
  Self operator+( const RealTimeInterval & ) const;
  Self operator-( const RealTimeInterval & ) const;
  const Self & operator+=( const RealTimeInterval & );
  const Self & operator-=( const RealTimeInterval & );

  bool operator>( const Self & ) const;
  bool operator<( const Self & ) const;
  bool operator==( const Self & ) const;
  bool operator!=( const Self & ) const;
  bool operator<=( const Self & ) const;
  bool operator>=( const Self & ) const;

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

private:

  using SecondsCounterType = uint64_t;
  using MicroSecondsCounterType = uint64_t;

  RealTimeStamp( SecondsCounterType, MicroSecondsCounterType );

  using SecondsDifferenceType = RealTimeInterval::SecondsDifferenceType;
  using MicroSecondsDifferenceType = RealTimeInterval::MicroSecondsDifferenceType;

  SecondsCounterType        m_Seconds;
  MicroSecondsCounterType   m_MicroSeconds;

};

} // end of namespace itk

#endif  // itkRealTimeStamp_h