itkRealTimeClock.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 itkRealTimeClock_h
#define itkRealTimeClock_h
 
#include "itkMacro.h"
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkRealTimeStamp.h"
 
namespace itk
{
 
class ITKCommon_EXPORT RealTimeClock : public Object
{
public:
  using Self = RealTimeClock;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;

  itkOverrideGetNameOfClassMacro(RealTimeClock);

  itkNewMacro(Self);

  using TimeStampType = double;

  using FrequencyType = double;

  TimeStampType
  GetTimeInSeconds() const;

  itkGetConstMacro(Frequency, FrequencyType);

  RealTimeStamp
  GetRealTimeStamp() const;
 
protected:
  RealTimeClock();

  ~RealTimeClock() override;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
 
private:
  FrequencyType m_Frequency{ 1 };
  TimeStampType m_Difference{};
  TimeStampType m_Origin{};
 
  // Returns a timestamp in a TimeStamp data structure.
  // We hide this method in the private section, because it returns the
  // modified time of the itk::Object. That modified time is ambiguous with
  // the role of the RealTimeStamp.
  const TimeStamp &
  GetTimeStamp() const override;
};
} // end of namespace itk
 
#endif // itkRealTimeClock_h