rtkResourceProbesCollector.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright RTK Consortium
 *
 *  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 rtkResourceProbesCollector_h
#define rtkResourceProbesCollector_h

#include "RTKExport.h"
#include "rtkConfiguration.h"
#include <itkTimeProbe.h>
#include <itkMemoryProbe.h>

#ifdef RTK_USE_CUDA
#  include <itkCudaMemoryProbe.h>
#endif

namespace rtk
{
class RTK_EXPORT ResourceProbesCollector
{
public:
  using IdType = std::string;
  using TimeMapType = std::map<IdType, itk::TimeProbe>;
  using MemoryMapType = std::map<IdType, itk::MemoryProbe>;
#ifdef RTK_USE_CUDA
  using CudaMemoryMapType = std::map<IdType, itk::CudaMemoryProbe>;
#endif

  virtual ~ResourceProbesCollector() = default;

  virtual void
  Start(const char * id);

  virtual void
  Stop(const char * id);

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

  virtual void
  Clear();

protected:
  TimeMapType   m_TimeProbes;
  MemoryMapType m_MemoryProbes;
#ifdef RTK_USE_CUDA
  CudaMemoryMapType m_CudaMemoryProbes;
#endif
};
} // namespace rtk

#endif // rtkResourceProbesCollector_h