MLMemoryProfile Class Reference

#include <mlMemoryProfile.h>

Public Member Functions
	MLMemoryProfile (MLCurrentlyUsedMemoryTracker *tracker, const std::string &shortDescription)
	~MLMemoryProfile ()
void	addMemory (MLProfilingMemoryType memory)
	Adds allocated memory.
MLProfilingMemoryType	getMemory () const
	Returns the used memory since instantiation/last reset.
MLProfilingMemoryType	getCurrentlyUsedMemory () const
	Returns the currently used memory in bytes.
void	reset ()
	Resets the profile.
const std::string &	shortDescription () const
const std::string &	description () const
void	setDescription (const std::string &description_)

Friends
class	MLCurrentlyUsedMemoryTracker

Detailed Description

Definition at line 42 of file mlMemoryProfile.h.

Constructor & Destructor Documentation

MLMemoryProfile()

MLMemoryProfile::MLMemoryProfile	(	MLCurrentlyUsedMemoryTracker *	tracker,
		const std::string &	shortDescription )

~MLMemoryProfile()

MLMemoryProfile::~MLMemoryProfile

(

)

Member Function Documentation

addMemory()

void MLMemoryProfile::addMemory

(

MLProfilingMemoryType

memory

)

Adds allocated memory.

description()

const std::string & MLMemoryProfile::description ( ) const

inline

Definition at line 58 of file mlMemoryProfile.h.

getCurrentlyUsedMemory()

MLProfilingMemoryType MLMemoryProfile::getCurrentlyUsedMemory

(

)

const

Returns the currently used memory in bytes.

getMemory()

MLProfilingMemoryType MLMemoryProfile::getMemory

(

)

const

Returns the used memory since instantiation/last reset.

reset()

void MLMemoryProfile::reset

(

)

Resets the profile.

setDescription()

void MLMemoryProfile::setDescription ( const std::string & description_ )

inline

Definition at line 59 of file mlMemoryProfile.h.

References mlrange_cast().

shortDescription()

const std::string & MLMemoryProfile::shortDescription ( ) const

inline

Definition at line 56 of file mlMemoryProfile.h.

Friends And Related Symbol Documentation

MLCurrentlyUsedMemoryTracker

friend class MLCurrentlyUsedMemoryTracker

friend

Definition at line 70 of file mlMemoryProfile.h.

---

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

• MeVis/Foundation/Sources/MLProfilingManager/Include/mlMemoryProfile.h