#include <mlMetaProfile.h>

Public Types
enum	MLProfilingFunctionType { MLCall = 0 , PythonCall = 1 , FieldNotificationCall = 2 , CppCall = 3 , GLRenderCall = 4 , PythonQtCall = 5 , MLWEMCall = 6 , MDLCommandCall = 7 , MainFunctionCall = 8 , CallTypeCount = 9 }

Public Member Functions
const std::vector< MLMetaProfile * > &	getSubMetaProfiles () const
	Returns the submetaprofiles.

void	addSubMetaProfile (MLMetaProfile *subMetaProfile)
	Adds a submetaprofile.

MLCountProfile *	createCountProfile (const std::string &key)
	Creates a count profile.

MLCountProfile *	getCountProfile (const std::string &key) const
	Returns a count profile, or NULL if it does not exist.

bool	incrementCountValue (const std::string &key)
	Increments the count profile value by 1.

MLProfilingCountType	getCountValue (const std::string &key, bool *ok=nullptr) const
	Returns the current value of a count profile.

const MLCountProfileMap &	getCountProfileMap () const
	Returns the map which contains count profiles by functions.

void	setCountProfileDescription (const std::string &key, const std::string &description)
	Sets the description of the count profile.

MLMemoryProfile *	createMemoryProfile (const std::string &key, MLCurrentlyUsedMemoryTracker *tracker)
	Creates a memory profile.

MLMemoryProfile *	getMemoryProfile (const std::string &key) const
	Returns a memory profile, or NULL if it does not exist.

bool	addMemory (const std::string &key, MLProfilingMemoryType memory)
	Adds allocated memory to a memory profile.

MLProfilingMemoryType	getMemory (const std::string &key, bool *ok=nullptr) const
	Returns the overall used memory in bytes of a memory profile.

MLProfilingMemoryType	getAllMemory () const
	Returns the sum of the overall used memory of all memory profiles.

MLProfilingMemoryType	getCurrentlyUsedMemory (const std::string &key, bool *ok=nullptr) const
	Returns the currently used memory in bytes of a memory profile.

MLProfilingMemoryType	getAllCurrentlyUsedMemory () const
	Returns the sum of the currently used memory of all memory profiles.

const MLMemoryProfileMap &	getMemoryProfileMap () const
	Returns the map which contains memory profiles by functions.

void	setMemoryProfileDescription (const std::string &key, const std::string &description)
	Sets the description of the memory profile.

MLTimeProfileHandle	startMeasuring (const std::string &function, int userId, void *userData=nullptr, const std::string &filename="", int linenumber=-1, const std::string &nodeInfo="")
	Starts measuring time.

void	stopMeasuring (MLTimeProfileHandle &handle, bool ignoreIfEmpty=false)
	Stops measuring time and associates the elapsed time.

MLTimeProfile *	getTimeProfile () const
	Returns the time profile.

void	setDescription (const std::string &description_)
	Sets the metaprofile's description.

const std::string &	description () const
	Returns the metaprofile's description.

	~MLMetaProfile ()

Static Public Member Functions
static const char *	functionTypeToString (MLProfilingFunctionType type)

Friends
class	MLMetaProfilePtr

class	MLProfilingManager

Detailed Description

Definition at line 35 of file mlMetaProfile.h.

Member Enumeration Documentation

◆ MLProfilingFunctionType

enum MLMetaProfile::MLProfilingFunctionType

Enumerator
MLCall
PythonCall
FieldNotificationCall
CppCall
GLRenderCall
PythonQtCall
MLWEMCall
MDLCommandCall
MainFunctionCall
CallTypeCount

Definition at line 38 of file mlMetaProfile.h.

Constructor & Destructor Documentation

◆ ~MLMetaProfile()

MLMetaProfile::~MLMetaProfile ( )

Member Function Documentation

◆ addMemory()

bool MLMetaProfile::addMemory	(	const std::string &	key,
		MLProfilingMemoryType	memory
	)

Adds allocated memory to a memory profile.

Parameters

key	The key that identifies the memory profile.
memory	The amount of newly allocated memory.

Returns: true if the memory profile does exist; otherwise, it returns false.

◆ addSubMetaProfile()

void MLMetaProfile::addSubMetaProfile ( MLMetaProfile * subMetaProfile )

inline

Adds a submetaprofile.

Definition at line 57 of file mlMetaProfile.h.

◆ createCountProfile()

MLCountProfile * MLMetaProfile::createCountProfile ( const std::string & key )

Creates a count profile.

Parameters

key	The key that identifies the count profile.

Returns: NULL if either no memory is available, or if a count profile with the given key already exists.

◆ createMemoryProfile()

MLMemoryProfile * MLMetaProfile::createMemoryProfile	(	const std::string &	key,
		MLCurrentlyUsedMemoryTracker *	tracker
	)

Creates a memory profile.

Parameters

key	The key that identifies the memory profile.
tracker	The MLCurrentlyUsedMemoryTracker must be set, which is required to read the currently used amount of memory.

Returns: NULL if either no memory is available, or if a memory profile with the given key already exists.

◆ description()

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

inline

Returns the metaprofile's description.

Definition at line 178 of file mlMetaProfile.h.

◆ functionTypeToString()

static const char * MLMetaProfile::functionTypeToString ( MLProfilingFunctionType type )

static

◆ getAllCurrentlyUsedMemory()

MLProfilingMemoryType MLMetaProfile::getAllCurrentlyUsedMemory ( ) const

Returns the sum of the currently used memory of all memory profiles.

◆ getAllMemory()

MLProfilingMemoryType MLMetaProfile::getAllMemory ( ) const

Returns the sum of the overall used memory of all memory profiles.

◆ getCountProfile()

MLCountProfile * MLMetaProfile::getCountProfile ( const std::string & key ) const

Returns a count profile, or NULL if it does not exist.

Parameters

key	The key that identifies the count profile.

◆ getCountProfileMap()

const MLCountProfileMap & MLMetaProfile::getCountProfileMap ( ) const

inline

Returns the map which contains count profiles by functions.

Definition at line 86 of file mlMetaProfile.h.

◆ getCountValue()

MLProfilingCountType MLMetaProfile::getCountValue	(	const std::string &	key,
		bool *	ok = `nullptr`
	)		const

Returns the current value of a count profile.

Parameters

key	The key that identifies the count profile.
ok	If ok is a valid pointer, then it will be set to false if no count profile with the given key exists.

Returns: The current count profile value, or std::numeric_limits<MLProfilingCountType>::max() if the count profile does not exist.

◆ getCurrentlyUsedMemory()

MLProfilingMemoryType MLMetaProfile::getCurrentlyUsedMemory	(	const std::string &	key,
		bool *	ok = `nullptr`
	)		const

Returns the currently used memory in bytes of a memory profile.

Parameters

key	The key that identifies the memory profile.
ok	If ok is a valid pointer, then it will be set to false if no memory profile with the given key exists.

Returns: The currently used memory, or std::numeric_limits<MLProfilingMemoryType>::max() if the memory profile does not exist.

◆ getMemory()

MLProfilingMemoryType MLMetaProfile::getMemory	(	const std::string &	key,
		bool *	ok = `nullptr`
	)		const

Returns the overall used memory in bytes of a memory profile.

Parameters

key	The key that identifies the memory profile.
ok	If ok is a valid pointer, then it will be set to false if no memory profile with the given key exists.

Returns: The added memory since instantiation/last reset, or std::numeric_limits<MLProfilingMemoryType>::max() if the memory profile does not exist.

◆ getMemoryProfile()

MLMemoryProfile * MLMetaProfile::getMemoryProfile ( const std::string & key ) const

Returns a memory profile, or NULL if it does not exist.

Parameters

key	The key that identifies the memory profile.

◆ getMemoryProfileMap()

const MLMemoryProfileMap & MLMetaProfile::getMemoryProfileMap ( ) const

inline

Returns the map which contains memory profiles by functions.

Definition at line 140 of file mlMetaProfile.h.

◆ getSubMetaProfiles()

const std::vector< MLMetaProfile * > & MLMetaProfile::getSubMetaProfiles ( ) const

inline

Returns the submetaprofiles.

Definition at line 54 of file mlMetaProfile.h.

◆ getTimeProfile()

MLTimeProfile * MLMetaProfile::getTimeProfile ( ) const

inline

Returns the time profile.

Definition at line 171 of file mlMetaProfile.h.

◆ incrementCountValue()

bool MLMetaProfile::incrementCountValue ( const std::string & key )

Increments the count profile value by 1.

Parameters

key	The key that identifies the count profile.

Returns: true if the count profile does exist; otherwise, it returns false.

◆ setCountProfileDescription()

void MLMetaProfile::setCountProfileDescription	(	const std::string &	key,
		const std::string &	description
	)

Sets the description of the count profile.

Parameters

key	The key that identifies the count profile.

◆ setDescription()

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

inline

Sets the metaprofile's description.

Definition at line 176 of file mlMetaProfile.h.

◆ setMemoryProfileDescription()

void MLMetaProfile::setMemoryProfileDescription	(	const std::string &	key,
		const std::string &	description
	)

Sets the description of the memory profile.

Parameters

key	The key that identifies the memory profile.

◆ startMeasuring()

MLTimeProfileHandle MLMetaProfile::startMeasuring	(	const std::string &	function,
		int	userId,
		void *	userData = `nullptr`,
		const std::string &	filename = `""`,
		int	linenumber = `-1`,
		const std::string &	nodeInfo = `""`
	)

inline

Starts measuring time.

Parameters

function	The function identifies the measurement.
userId	The user id can be any integer, it is just stored.
userData	Optional data that is stored in the call graph nodes.

Returns: The MLTimeProfileHandle that is required to stop the measurement.

Definition at line 156 of file mlMetaProfile.h.

Referenced by ml::internal::ProfilingScope::startMeasuring().

◆ stopMeasuring()

void MLMetaProfile::stopMeasuring	(	MLTimeProfileHandle &	handle,
		bool	ignoreIfEmpty = `false`
	)

inline

Stops measuring time and associates the elapsed time.

Parameters

handle The MLTimeProfileHandle returned by startMeasuring() must be given.

Definition at line 168 of file mlMetaProfile.h.

Friends And Related Symbol Documentation

◆ MLMetaProfilePtr

friend class MLMetaProfilePtr

friend

Definition at line 200 of file mlMetaProfile.h.

◆ MLProfilingManager

friend class MLProfilingManager

friend

Definition at line 201 of file mlMetaProfile.h.

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

MeVis/Foundation/Sources/MLProfilingManager/Include/mlMetaProfile.h

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ MLProfilingFunctionType

Constructor & Destructor Documentation

◆ ~MLMetaProfile()

Member Function Documentation

◆ addMemory()

◆ addSubMetaProfile()

◆ createCountProfile()

◆ createMemoryProfile()

◆ description()

◆ functionTypeToString()

◆ getAllCurrentlyUsedMemory()

◆ getAllMemory()

◆ getCountProfile()

◆ getCountProfileMap()

◆ getCountValue()

◆ getCurrentlyUsedMemory()

◆ getMemory()

◆ getMemoryProfile()

◆ getMemoryProfileMap()

◆ getSubMetaProfiles()

◆ getTimeProfile()

◆ incrementCountValue()

◆ setCountProfileDescription()

◆ setDescription()

◆ setMemoryProfileDescription()

◆ startMeasuring()

◆ stopMeasuring()

Friends And Related Symbol Documentation

◆ MLMetaProfilePtr

◆ MLProfilingManager