Profiler Class Reference

The armarx::Profiler::Profiler class can be used for timing executions within the ArmarX framework. More...

#include <ArmarXCore/core/services/profiler/Profiler.h>

Public Types
enum	EventType { eFunctionStart = 0 , eFunctionReturn , eFunctionBreak , eNumberEventTypes }
	The EventType enum provides symbolic names for the different events which can be logged via armarx::Profiler::Profiler::logEvent() More...
using	EventTypeMap = std::map<Profiler::EventType, std::string>

Public Member Functions
void	logEvent (Profiler::EventType eventType, const std::string &parentName, const std::string &functionName)
void	logProcessCpuUsage (float cpuUsage)
void	logProcessMemoryUsage (int memoryUsage)
void	logStatechartInputParameters (const std::string &stateIdentifier, const armarx::StateParameterMap &inputParameterMap)
void	logStatechartLocalParameters (const std::string &stateIdentifier, const armarx::StateParameterMap &localParameterMap)
void	logStatechartOutputParameters (const std::string &stateIdentifier, const armarx::StateParameterMap &outputParameterMap)
void	logStatechartTransition (const std::string &parentStateIdentifier, const StateIceBasePtr &sourceState, const StateIceBasePtr &destinationState, const std::string &eventName)
void	logStatechartTransitionWithParameters (const TransitionIceBase &transition)
	Profiler ()
void	reset ()
	reset reinitializes armarx::Profiler::Profiler::startTime with the current time.
void	setLoggingStrategy (LoggingStrategyPtr loggingStrategy)
void	setName (const std::string &profilerName)
	~Profiler ()

Static Public Member Functions
static std::string	GetEventName (Profiler::EventType eventType)
	getEventName maps enum values from armarx::Profiler::Profiler::EventType to strings

Protected Attributes
std::string	profilerName

Detailed Description

The armarx::Profiler::Profiler class can be used for timing executions within the ArmarX framework.

The armarx::Profiler::Profiler class provides methods for logging events and statechart transitions. Changing the logging behavior requires calling armarx::Profiler::Profiler::setLoggingStrategy() with a specialized implementation of armarx::Profiler::LoggingStrategy. By default, all calls to log functions are ignored.

Member Typedef Documentation

EventTypeMap

using EventTypeMap = std::map<Profiler::EventType, std::string>

Member Enumeration Documentation

EventType

enum EventType

The EventType enum provides symbolic names for the different events which can be logged via armarx::Profiler::Profiler::logEvent()

Enumerator
eFunctionStart
eFunctionReturn
eFunctionBreak
eNumberEventTypes

Constructor & Destructor Documentation

Profiler()

Profiler

(

)

~Profiler()

~Profiler

(

)

Member Function Documentation

GetEventName()

std::string GetEventName ( Profiler::EventType eventType )

static

getEventName maps enum values from armarx::Profiler::Profiler::EventType to strings

Parameters

eventType

Returns

string representation of the enum value

logEvent()

void logEvent	(	Profiler::EventType	eventType,
		const std::string &	parentName,
		const std::string &	functionName )

logProcessCpuUsage()

void logProcessCpuUsage

(

float

cpuUsage

)

logProcessMemoryUsage()

void logProcessMemoryUsage

(

int

memoryUsage

)

logStatechartInputParameters()

void logStatechartInputParameters	(	const std::string &	stateIdentifier,
		const armarx::StateParameterMap &	inputParameterMap )

logStatechartLocalParameters()

void logStatechartLocalParameters	(	const std::string &	stateIdentifier,
		const armarx::StateParameterMap &	localParameterMap )

logStatechartOutputParameters()

void logStatechartOutputParameters	(	const std::string &	stateIdentifier,
		const armarx::StateParameterMap &	outputParameterMap )

logStatechartTransition()

void logStatechartTransition	(	const std::string &	parentStateIdentifier,
		const StateIceBasePtr &	sourceState,
		const StateIceBasePtr &	destinationState,
		const std::string &	eventName )

logStatechartTransitionWithParameters()

void logStatechartTransitionWithParameters

(

const TransitionIceBase &

transition

)

reset()

void reset ( )

inline

reset reinitializes armarx::Profiler::Profiler::startTime with the current time.

setLoggingStrategy()

void setLoggingStrategy

(

LoggingStrategyPtr

loggingStrategy

)

setName()

void setName

(

const std::string &

profilerName

)

Member Data Documentation

profilerName

std::string profilerName

protected

---

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

• ArmarXCore/core/services/profiler/Profiler.h
• ArmarXCore/core/services/profiler/Profiler.cpp