itkTimeStamp.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.
 *
 *=========================================================================*/
/*=========================================================================
 *
 *  Portions of this file are subject to the VTK Toolkit Version 3 copyright.
 *
 *  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 *
 *  For complete copyright, license and disclaimer of warranty information
 *  please refer to the NOTICE file at the top of the ITK source tree.
 *
 *=========================================================================*/
#ifndef itkTimeStamp_h
#define itkTimeStamp_h
 
#include "itkMacro.h"
#include "itkIntTypes.h"
#include <atomic>
#include "itkSingletonMacro.h"
 
namespace itk
{
class ITKCommon_EXPORT TimeStamp
{
public:
  using Self = TimeStamp;
 
  using GlobalTimeStampType = std::atomic<ModifiedTimeType>;
 
#ifndef ITK_LEGACY_REMOVE
  itkLegacyMacro(static Self * New();)

  itkLegacyMacro(void Delete())
  {
    delete this;
  }
#endif

  static const char *
  GetNameOfClass()
  {
    return "TimeStamp";
  }

  void
  Modified();

  [[nodiscard]] ModifiedTimeType
  GetMTime() const
  {
    return m_ModifiedTime;
  }

  bool
  operator>(TimeStamp & ts) const
  {
    return m_ModifiedTime > ts.m_ModifiedTime;
  }
  bool
  operator<(TimeStamp & ts) const
  {
    return m_ModifiedTime < ts.m_ModifiedTime;
  }

  operator ModifiedTimeType() const { return m_ModifiedTime; }
 
private:
  itkGetGlobalDeclarationMacro(GlobalTimeStampType, GlobalTimeStamp);
 
  ModifiedTimeType m_ModifiedTime{ 0 };

  static GlobalTimeStampType * m_GlobalTimeStamp;
};
} // end namespace itk
 
#endif