Orfeo Toolbox  4.2
Public Types | Public Member Functions | Protected Attributes | List of all members
itk::MapFileParser< TMapData > Class Template Referenceabstract

TODO. More...

#include <itkSmapsFileParser.h>

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

Public Types

typedef TMapData::MemoryLoadType MemoryLoadType
 

Public Member Functions

virtual ~MapFileParser ()
 
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 (void)
 

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 222 of file itkSmapsFileParser.h.

Member Typedef Documentation

template<typename TMapData>
typedef TMapData::MemoryLoadType itk::MapFileParser< TMapData >::MemoryLoadType

Definition at line 225 of file itkSmapsFileParser.h.

Constructor & Destructor Documentation

template<typename TMapDataType >
itk::MapFileParser< TMapDataType >::~MapFileParser ( )
virtual

Definition at line 38 of file itkSmapsFileParser.hxx.

Member Function Documentation

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

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

Definition at line 52 of file itkSmapsFileParser.hxx.

template<typename TMapDataType >
MapFileParser< TMapDataType >::MemoryLoadType itk::MapFileParser< TMapDataType >::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.

Definition at line 88 of file itkSmapsFileParser.hxx.

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

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

Definition at line 64 of file itkSmapsFileParser.hxx.

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

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

Definition at line 76 of file itkSmapsFileParser.hxx.

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 >.

template<typename TMapDataType >
bool itk::MapFileParser< TMapDataType >::Update ( void  )

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

Definition at line 43 of file itkSmapsFileParser.hxx.

Member Data Documentation

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

Definition at line 261 of file itkSmapsFileParser.h.

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

Definition at line 260 of file itkSmapsFileParser.h.


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

Generated at Sat Aug 30 2014 17:33:01 for Orfeo Toolbox with doxygen 1.8.3.1