ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes
itk::MemoryProbe Class Reference

#include <itkMemoryProbe.h>

+ Inheritance diagram for itk::MemoryProbe:
+ Collaboration diagram for itk::MemoryProbe:

List of all members.

Public Types

typedef double MeanMemoryLoadType
typedef SizeValueType MemoryLoadType
- Public Types inherited from itk::ResourceProbe< SizeValueType, double >
typedef SizeValueType CountType

Public Member Functions

 MemoryProbe ()
 ~MemoryProbe ()
- Public Member Functions inherited from itk::ResourceProbe< SizeValueType, double >
double GetMean (void) const
CountType GetNumberOfStarts (void) const
CountType GetNumberOfStops (void) const
SizeValueType GetTotal (void) const
std::string GetType (void) const
std::string GetUnit (void) const
 ResourceProbe (const std::string &type, const std::string &unit)
void Start (void)
void Stop (void)
virtual ~ResourceProbe ()

Protected Member Functions

virtual MemoryLoadType GetInstantValue (void) const

Private Attributes

MemoryUsageObserver m_MemoryObserver

Detailed Description

Computes the memory allocated between two points in code.

This class allows the user to trace the memory charge between the execution of two pieces of code. It can be started and stopped in order to evaluate the execution over multiple passes. The values of memory are taken from GetProcessMemoryInfo() for Windows, the SMAPS file for Linux and getrusage() otherwise.

Definition at line 39 of file itkMemoryProbe.h.


Member Typedef Documentation

Type for measuring the average memory.

Definition at line 51 of file itkMemoryProbe.h.

Type for measuring memory.

Definition at line 48 of file itkMemoryProbe.h.


Constructor & Destructor Documentation

itk::MemoryProbe::MemoryProbe ( )
itk::MemoryProbe::~MemoryProbe ( )

Member Function Documentation

virtual MemoryLoadType itk::MemoryProbe::GetInstantValue ( void  ) const
protectedvirtual

Returns the instant value of the probed system.

Implements itk::ResourceProbe< SizeValueType, double >.


Member Data Documentation

MemoryUsageObserver itk::MemoryProbe::m_MemoryObserver
mutableprivate

Definition at line 56 of file itkMemoryProbe.h.


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