ProfileFuncLevel::Id Class Reference

A function level profile ID. More...

#include <profile_funclevel.h>

Public Types
enum	{ Total = 0xffffffff }
	special 'frame' numbers More...

Public Member Functions
	Id (void)
const char *	GetSource (void) const
	Returns the source file this Id is in.
const char *	GetFunction (void) const
	Returns the function name for this Id.
unsigned	GetAddress (void) const
	Returns function address.
unsigned	GetLine (void) const
	Returns the line number for this Id.
unsigned _int64	GetCalls (unsigned frame) const
	Determine call counts.
unsigned _int64	GetTime (unsigned frame) const
	Determine time spend in this function and its children.
unsigned _int64	GetFunctionTime (unsigned frame) const
	Determine time spend in this function only (exclude any time spend in child functions).
IdList	GetCaller (unsigned frame) const
	Determine the list of caller Ids.

Detailed Description

A function level profile ID.

Definition at line 81 of file profile_funclevel.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

special 'frame' numbers

Enumerator
Total	return the total value/count

Definition at line 90 of file profile_funclevel.h.

Constructor & Destructor Documentation

Id()

ProfileFuncLevel::Id::Id ( void )

inline

Definition at line 87 of file profile_funclevel.h.

Member Function Documentation

GetAddress()

unsigned ProfileFuncLevel::Id::GetAddress

(

void

)

const

Returns function address.

Returns

function address

Definition at line 740 of file profile_funclevel.cpp.

GetCaller()

ProfileFuncLevel::IdList ProfileFuncLevel::Id::GetCaller

(

unsigned

frame

)

const

Determine the list of caller Ids.

Parameters

frame

number of recorded frame, or Total

Returns

Caller Id list (actually just a handle value)

Definition at line 765 of file profile_funclevel.cpp.

GetCalls()

unsigned _int64 ProfileFuncLevel::Id::GetCalls

(

unsigned

frame

)

const

Determine call counts.

Parameters

frame

number of recorded frame, or Total

Returns

number of calls

Definition at line 750 of file profile_funclevel.cpp.

GetFunction()

const char * ProfileFuncLevel::Id::GetFunction

(

void

)

const

Returns the function name for this Id.

Returns

function name, may be NULL

Definition at line 735 of file profile_funclevel.cpp.

GetFunctionTime()

unsigned _int64 ProfileFuncLevel::Id::GetFunctionTime

(

unsigned

frame

)

const

Determine time spend in this function only (exclude any time spend in child functions).

Parameters

frame

number of recorded frame, or Total

Returns

time spend in this function alone (in CPU ticks)

Definition at line 760 of file profile_funclevel.cpp.

GetLine()

unsigned ProfileFuncLevel::Id::GetLine

(

void

)

const

Returns the line number for this Id.

Returns

line number, 0 if unknown

Definition at line 745 of file profile_funclevel.cpp.

GetSource()

const char * ProfileFuncLevel::Id::GetSource

(

void

)

const

Returns the source file this Id is in.

Returns

source file name, may be NULL

Definition at line 730 of file profile_funclevel.cpp.

GetTime()

unsigned _int64 ProfileFuncLevel::Id::GetTime

(

unsigned

frame

)

const

Determine time spend in this function and its children.

Parameters

frame

number of recorded frame, or Total

Returns

time spend (in CPU ticks)

Definition at line 755 of file profile_funclevel.cpp.

---

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

• Code/Libraries/Source/profile/profile_funclevel.h
• Code/Libraries/Source/profile/profile_funclevel.cpp