rtk::GlobalResourceProbe Class Reference

#include <rtkGlobalResourceProbe.h>

Inheritance diagram for rtk::GlobalResourceProbe:

Collaboration diagram for rtk::GlobalResourceProbe:

Public Types
using	ConstPointer = itk::SmartPointer< const Self >
using	Pointer = itk::SmartPointer< Self >
using	Self = GlobalResourceProbe
using	Superclass = itk::Object

Public Member Functions
virtual void	Clear ()
virtual void	Remove (const rtk::WatcherForResourceProbe *w)
virtual void	Report (std::ostream &os=std::cout) const
virtual void	Start (const char *id)
virtual void	Stop (const char *id)
virtual void	Watch (itk::ProcessObject *o)
virtual const char *	GetNameOfClass () const
virtual void	SetVerbose (bool _arg)
virtual bool	GetVerbose ()

Static Public Member Functions
static Pointer	GetInstance ()
static Pointer	New ()

Protected Member Functions
	GlobalResourceProbe ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~GlobalResourceProbe () override

Protected Attributes
ResourceProbesCollector	m_ResourceProbesCollector
bool	m_Verbose
std::vector< rtk::WatcherForResourceProbe * >	m_Watchers

Private Attributes
std::mutex	m_Mutex

Static Private Attributes
static Pointer	m_Instance

Detailed Description

Definition at line 36 of file rtkGlobalResourceProbe.h.

Member Typedef Documentation

ConstPointer

using rtk::GlobalResourceProbe::ConstPointer = itk::SmartPointer<const Self>

Definition at line 45 of file rtkGlobalResourceProbe.h.

Pointer

using rtk::GlobalResourceProbe::Pointer = itk::SmartPointer<Self>

Definition at line 44 of file rtkGlobalResourceProbe.h.

Self

using rtk::GlobalResourceProbe::Self = GlobalResourceProbe

Standard class type alias.

Definition at line 42 of file rtkGlobalResourceProbe.h.

Superclass

using rtk::GlobalResourceProbe::Superclass = itk::Object

Definition at line 43 of file rtkGlobalResourceProbe.h.

Constructor & Destructor Documentation

GlobalResourceProbe()

rtk::GlobalResourceProbe::GlobalResourceProbe ( )

protected

~GlobalResourceProbe()

rtk::GlobalResourceProbe::~GlobalResourceProbe ( )

overrideprotected

Member Function Documentation

Clear()

virtual void rtk::GlobalResourceProbe::Clear ( )

virtual

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

GetInstance()

static Pointer rtk::GlobalResourceProbe::GetInstance ( )

static

Return the singleton instance with no reference counting.

Referenced by rtk::args_info_manager< TArgsInfo, TCleanupFunction >::args_info_manager().

GetNameOfClass()

virtual const char* rtk::GlobalResourceProbe::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

GetVerbose()

virtual bool rtk::GlobalResourceProbe::GetVerbose ( )

virtual

Set / Get macro for verbosity

New()

static Pointer rtk::GlobalResourceProbe::New ( )

static

This is a singleton pattern New. There will only be ONE reference to a GlobalResourceProbe object per process. Clients that call this must call Delete on the object so that the reference counting will work. The single instance will be unreferenced when the program exits.

PrintSelf()

void rtk::GlobalResourceProbe::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Reimplemented from itk::Object.

Remove()

virtual void rtk::GlobalResourceProbe::Remove ( const rtk::WatcherForResourceProbe *  w )

virtual

Remove a watcher

Report()

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

virtual

Report the summary of results from the probes

SetVerbose()

virtual void rtk::GlobalResourceProbe::SetVerbose ( bool  _arg )

virtual

Set / Get macro for verbosity

Start()

virtual void rtk::GlobalResourceProbe::Start ( const char *  id )

virtual

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

Stop()

virtual void rtk::GlobalResourceProbe::Stop ( const char *  id )

virtual

Stop a time probe identified with a name

Watch()

virtual void rtk::GlobalResourceProbe::Watch ( itk::ProcessObject *  o )

virtual

Create a new watcher and store it

Member Data Documentation

m_Instance

Pointer rtk::GlobalResourceProbe::m_Instance

staticprivate

Definition at line 109 of file rtkGlobalResourceProbe.h.

m_Mutex

std::mutex rtk::GlobalResourceProbe::m_Mutex

private

Definition at line 110 of file rtkGlobalResourceProbe.h.

m_ResourceProbesCollector

ResourceProbesCollector rtk::GlobalResourceProbe::m_ResourceProbesCollector

protected

Definition at line 105 of file rtkGlobalResourceProbe.h.

m_Verbose

bool rtk::GlobalResourceProbe::m_Verbose

protected

Definition at line 103 of file rtkGlobalResourceProbe.h.

m_Watchers

std::vector<rtk::WatcherForResourceProbe *> rtk::GlobalResourceProbe::m_Watchers

protected

Definition at line 106 of file rtkGlobalResourceProbe.h.

---

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

• rtkGlobalResourceProbe.h