itkMemoryProbe.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 itkMemoryProbe_h
#define itkMemoryProbe_h
 
#include "itkResourceProbe.h"
#include "itkMemoryUsageObserver.h"
#include "itkIntTypes.h"
 
namespace itk
{
class ITKCommon_EXPORT MemoryProbe : public ResourceProbe<OffsetValueType, double>
{
public:
  MemoryProbe();
  ~MemoryProbe() override;

  using MemoryLoadType = OffsetValueType;

  using MeanMemoryLoadType = double;
 
protected:
  MemoryLoadType
  GetInstantValue() const override;
 
private:
  mutable MemoryUsageObserver m_MemoryObserver{};
};
} // end namespace itk
 
#endif // itkMemoryProbe_h