itkResourceProbe.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 itkResourceProbe_h
#define itkResourceProbe_h
 
#include "itkMacro.h"
#include "itkIndent.h"
#include "itkIntTypes.h"
 
#include <iostream> // For cout.
#include <string>
#include <vector>
 
#include "ITKCommonExport.h"
 
namespace itk
{
template <typename ValueType, typename MeanType>
class ITK_TEMPLATE_EXPORT ResourceProbe
{
public:
  using CountType = SizeValueType;
 
public:
  ResourceProbe(std::string type, std::string unit);

  virtual ~ResourceProbe() = default;
 
  ResourceProbe(const ResourceProbe &) = default;
  ResourceProbe(ResourceProbe &&) = default;
  ResourceProbe &
  operator=(const ResourceProbe &) = default;
  ResourceProbe &
  operator=(ResourceProbe &&) = default;

  [[nodiscard]] std::string
  GetType() const;

  [[nodiscard]] std::string
  GetUnit() const;

  virtual void
  Start();

  virtual void
  Stop();

  [[nodiscard]] CountType
  GetNumberOfStarts() const;

  [[nodiscard]] CountType
  GetNumberOfStops() const;

  [[nodiscard]] CountType
  GetNumberOfIteration() const;

  [[nodiscard]] virtual ValueType
  GetInstantValue() const = 0;

  [[nodiscard]] virtual ValueType
  GetTotal() const;

  [[nodiscard]] virtual MeanType
  GetMean() const;

  virtual void
  Reset();

  [[nodiscard]] virtual ValueType
  GetMinimum() const;

  [[nodiscard]] virtual ValueType
  GetMaximum() const;

  virtual ValueType
  GetStandardDeviation();

  virtual ValueType
  GetStandardError();

  virtual void
  SetNameOfProbe(const char * nameOfProbe);

  [[nodiscard]] virtual std::string
  GetNameOfProbe() const;

  virtual void
  PrintSystemInformation(std::ostream & os = std::cout);

  virtual void
  Report(std::ostream & os = std::cout, bool printSystemInfo = true, bool printReportHead = true, bool useTabs = false);

  virtual void
  ExpandedReport(std::ostream & os = std::cout,
                 bool           printSystemInfo = true,
                 bool           printReportHead = true,
                 bool           useTabs = false);

  virtual void
  JSONReport(std::ostream & os = std::cout);

  virtual void
  PrintJSONSystemInformation(std::ostream & os = std::cout);
 
protected:
  virtual void
  UpdateMinimumMaximumMeasuredValue(ValueType value);

  virtual void
  PrintReportHead(std::ostream & os = std::cout, bool useTabs = false);

  virtual void
  PrintExpandedReportHead(std::ostream & os = std::cout, bool useTabs = false);

  template <typename T>
  void
  PrintJSONvar(std::ostream & os, const char * varName, T varValue, unsigned int indent = 4, bool comma = true);

  virtual void
  Print(std::ostream & os, Indent indent) const;
 
private:
  ValueType m_StartValue{};
  ValueType m_TotalValue{};
  ValueType m_MinimumValue{};
  ValueType m_MaximumValue{};
  ValueType m_StandardDeviation{};
  ValueType m_StandardError{};
 
  CountType m_NumberOfStarts{};
  CountType m_NumberOfStops{};
  CountType m_NumberOfIteration{};
 
  std::vector<ValueType> m_ProbeValueList{};
 
  std::string m_NameOfProbe{};
  std::string m_TypeString{};
  std::string m_UnitString{};
 
  static constexpr unsigned int tabwidth = 15;
};
} // end namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkResourceProbe.hxx"
#endif
 
#endif // itkResourceProbe_h