ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Protected Attributes | List of all members
itk::ResourceProbesCollectorBase< TProbe > Class Template Reference

#include <itkResourceProbesCollectorBase.h>

+ Inheritance diagram for itk::ResourceProbesCollectorBase< TProbe >:
+ Collaboration diagram for itk::ResourceProbesCollectorBase< TProbe >:

Public Types

using IdType = std::string
 
using MapType = std::map< IdType, TProbe >
 

Public Member Functions

virtual void Clear ()
 
virtual void ExpandedReport (const char *name, 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)
 
const TProbe & GetProbe (const char *name) const
 
virtual void JSONReport (const char *name, std::ostream &os=std::cout)
 
virtual void JSONReport (std::ostream &os=std::cout, bool printSystemInfo=true)
 
virtual void Report (const char *name, std::ostream &os=std::cout, bool printSystemInfo=true, bool printReportHead=true, bool useTabs=false)
 
virtual void Report (std::ostream &os=std::cout, bool printSystemInfo=true, bool printReportHead=true, bool useTabs=false)
 
virtual void Start (const char *name)
 
virtual void Stop (const char *name)
 
virtual ~ResourceProbesCollectorBase ()=default
 

Protected Attributes

MapType m_Probes
 

Detailed Description

template<typename TProbe>
class itk::ResourceProbesCollectorBase< TProbe >

Aggregates a set of probes.

This class defines a set of ResourceProbes and assign names to them. The user can start and stop each one of the probes by addressing them by name.

See also
ResourceProbe

Definition at line 38 of file itkResourceProbesCollectorBase.h.

Member Typedef Documentation

◆ IdType

template<typename TProbe>
using itk::ResourceProbesCollectorBase< TProbe >::IdType = std::string

Definition at line 41 of file itkResourceProbesCollectorBase.h.

◆ MapType

template<typename TProbe>
using itk::ResourceProbesCollectorBase< TProbe >::MapType = std::map<IdType, TProbe>

Definition at line 42 of file itkResourceProbesCollectorBase.h.

Constructor & Destructor Documentation

◆ ~ResourceProbesCollectorBase()

template<typename TProbe>
virtual itk::ResourceProbesCollectorBase< TProbe >::~ResourceProbesCollectorBase ( )
virtualdefault

destructor

Member Function Documentation

◆ Clear()

template<typename TProbe>
virtual void itk::ResourceProbesCollectorBase< TProbe >::Clear ( )
virtual

Destroy the set of probes. New probes can be created after invoking this method.

◆ ExpandedReport() [1/2]

template<typename TProbe>
virtual void itk::ResourceProbesCollectorBase< TProbe >::ExpandedReport ( const char *  name,
std::ostream &  os = std::cout,
bool  printSystemInfo = true,
bool  printReportHead = true,
bool  useTabs = false 
)
virtual

Expanded report of the summary of results from a specific probe

◆ ExpandedReport() [2/2]

template<typename TProbe>
virtual void itk::ResourceProbesCollectorBase< TProbe >::ExpandedReport ( std::ostream &  os = std::cout,
bool  printSystemInfo = true,
bool  printReportHead = true,
bool  useTabs = false 
)
virtual

Expanded report of the summary of results from all probes

◆ GetProbe()

template<typename TProbe>
const TProbe& itk::ResourceProbesCollectorBase< TProbe >::GetProbe ( const char *  name) const

Returns a named Probe. If the name does not exists an exception is thrown.

◆ JSONReport() [1/2]

template<typename TProbe>
virtual void itk::ResourceProbesCollectorBase< TProbe >::JSONReport ( const char *  name,
std::ostream &  os = std::cout 
)
virtual

JavaScript Object Notation (JSON) expanded report the summary of results from a specific probe

◆ JSONReport() [2/2]

template<typename TProbe>
virtual void itk::ResourceProbesCollectorBase< TProbe >::JSONReport ( std::ostream &  os = std::cout,
bool  printSystemInfo = true 
)
virtual

JavaScript Object Notation (JSON) expanded report the summary of results from all probes

◆ Report() [1/2]

template<typename TProbe>
virtual void itk::ResourceProbesCollectorBase< TProbe >::Report ( const char *  name,
std::ostream &  os = std::cout,
bool  printSystemInfo = true,
bool  printReportHead = true,
bool  useTabs = false 
)
virtual

Report the summary of results from a specific probe

◆ Report() [2/2]

template<typename TProbe>
virtual void itk::ResourceProbesCollectorBase< TProbe >::Report ( std::ostream &  os = std::cout,
bool  printSystemInfo = true,
bool  printReportHead = true,
bool  useTabs = false 
)
virtual

Report the summary of results from all probes

◆ Start()

template<typename TProbe>
virtual void itk::ResourceProbesCollectorBase< TProbe >::Start ( const char *  name)
virtual

Start a probe with a particular name. If the time probe does not exist, it will be created

◆ Stop()

template<typename TProbe>
virtual void itk::ResourceProbesCollectorBase< TProbe >::Stop ( const char *  name)
virtual

Stop a time probe identified with a name

Member Data Documentation

◆ m_Probes

template<typename TProbe>
MapType itk::ResourceProbesCollectorBase< TProbe >::m_Probes
protected

Definition at line 104 of file itkResourceProbesCollectorBase.h.


The documentation for this class was generated from the following file: