itkTimeProbe.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 itkTimeProbe_h
#define itkTimeProbe_h
 
#include "itkConfigure.h"
#include "itkResourceProbe.h"
#include "itkRealTimeClock.h"
 
namespace itk
{
class ITKCommon_EXPORT TimeProbe : public ResourceProbe<RealTimeClock::TimeStampType, RealTimeClock::TimeStampType>
{
public:
  using Superclass = ResourceProbe<RealTimeClock::TimeStampType, RealTimeClock::TimeStampType>;

  using CountType = unsigned long;

  using TimeStampType = RealTimeClock::TimeStampType;
 
public:
  TimeProbe();

  ~TimeProbe() override;
 
  TimeProbe(const TimeProbe &) = default;
  TimeProbe(TimeProbe &&) = default;
  TimeProbe &
  operator=(const TimeProbe &) = default;
  TimeProbe &
  operator=(TimeProbe &&) = default;
 
  void
  Print(std::ostream & os, Indent indent) const override;

  [[nodiscard]] TimeStampType
  GetInstantValue() const override;

  itkGetConstObjectMacro(RealTimeClock, RealTimeClock);
 
private:
  RealTimeClock::Pointer m_RealTimeClock{};
};
} // end namespace itk
 
#endif // itkTimeProbe_h