MeVisLabToolboxReference
Public Member Functions | Friends
MLMemoryProfile Class Reference

#include <mlMemoryProfile.h>

List of all members.

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 37 of file mlMemoryProfile.h.

Constructor & Destructor Documentation

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

Member Function Documentation

void MLMemoryProfile::addMemory ( MLProfilingMemoryType  memory)

Adds allocated memory.

const std::string& MLMemoryProfile::description ( ) const [inline]

Definition at line 53 of file mlMemoryProfile.h.

MLProfilingMemoryType MLMemoryProfile::getCurrentlyUsedMemory ( ) const

Returns the currently used memory in bytes.

MLProfilingMemoryType MLMemoryProfile::getMemory ( ) const

Returns the used memory since instantiation/last reset.

void MLMemoryProfile::reset ( )

Resets the profile.

void MLMemoryProfile::setDescription ( const std::string &  description_) [inline]

Definition at line 54 of file mlMemoryProfile.h.

const std::string& MLMemoryProfile::shortDescription ( ) const [inline]

Definition at line 51 of file mlMemoryProfile.h.

Friends And Related Function Documentation

friend class MLCurrentlyUsedMemoryTracker [friend]

Definition at line 65 of file mlMemoryProfile.h.

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