ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Protected Attributes | List of all members
itk::MapFileParser< TMapData > Class Template Referenceabstract

#include <itkSmapsFileParser.h>

+ Inheritance diagram for itk::MapFileParser< TMapData >:
+ Collaboration diagram for itk::MapFileParser< TMapData >:

Public Types

using MemoryLoadType = typename TMapData::MemoryLoadType
 

Public Member Functions

MemoryLoadType GetHeapUsage ()
 
MemoryLoadType GetMemoryUsage (const char *filter, const char *token="Size")
 
MemoryLoadType GetStackUsage ()
 
MemoryLoadType GetTotalMemoryUsage ()
 
virtual void ReadFile (const std::string &mapFileLocation="")=0
 
bool Update ()
 
virtual ~MapFileParser ()=default
 

Protected Attributes

TMapData m_MapData
 
std::string m_MapFilePath
 

Detailed Description

template<typename TMapData>
class itk::MapFileParser< TMapData >

TODO.

FIXME: Add documentation

Definition at line 236 of file itkSmapsFileParser.h.

Member Typedef Documentation

◆ MemoryLoadType

template<typename TMapData>
using itk::MapFileParser< TMapData >::MemoryLoadType = typename TMapData::MemoryLoadType

Definition at line 239 of file itkSmapsFileParser.h.

Constructor & Destructor Documentation

◆ ~MapFileParser()

template<typename TMapData>
virtual itk::MapFileParser< TMapData >::~MapFileParser ( )
virtualdefault

Member Function Documentation

◆ GetHeapUsage()

template<typename TMapData>
MemoryLoadType itk::MapFileParser< TMapData >::GetHeapUsage ( )

Returns the heap usage in kB of the process. If no file has been loaded yet, load a default file.

◆ GetMemoryUsage()

template<typename TMapData>
MemoryLoadType itk::MapFileParser< TMapData >::GetMemoryUsage ( const char *  filter,
const char *  token = "Size" 
)

Returns the memory usage in kB of a process segment. If no file has been loaded yet, load a default file.

◆ GetStackUsage()

template<typename TMapData>
MemoryLoadType itk::MapFileParser< TMapData >::GetStackUsage ( )

Returns the heap usage in kB of the process. If no file has been loaded yet, load a default file.

◆ GetTotalMemoryUsage()

template<typename TMapData>
MemoryLoadType itk::MapFileParser< TMapData >::GetTotalMemoryUsage ( )

Returns the total memory usage in kB of a process. If no file has been loaded yet, load a default file.

◆ ReadFile()

template<typename TMapData>
virtual void itk::MapFileParser< TMapData >::ReadFile ( const std::string &  mapFileLocation = "")
pure virtual

Load and parse a Map file pointed by mapFileLocation. If mapFileLocation is empty, load the default file Throw an exception is the file can't be opened.

Implemented in itk::VMMapFileParser< TVMMapDataType >, and itk::SmapsFileParser< TSmapsDataType >.

◆ Update()

template<typename TMapData>
bool itk::MapFileParser< TMapData >::Update ( )

ReRead the last parsed file to refresh the memory usage. Returns true if read from the default location "".

Member Data Documentation

◆ m_MapData

template<typename TMapData>
TMapData itk::MapFileParser< TMapData >::m_MapData
protected

Definition at line 281 of file itkSmapsFileParser.h.

◆ m_MapFilePath

template<typename TMapData>
std::string itk::MapFileParser< TMapData >::m_MapFilePath
protected

Definition at line 280 of file itkSmapsFileParser.h.


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