ipsdk::bench Namespace Reference

Namespace agregating IPSDK benchmark routines and classes. More...

Classes
class	BaseBenchCase
	Base class for benchmark cases. More...
class	BaseBenchSuite
	Base class for benchmark suites. More...
class	BenchCaseResult
class	BenchmarkInfo
class	BenchmarkManager
	Manager for benchmarks. More...
class	BenchmarkResult
class	BenchmarkResultInfo
	Benchmark result information. More...
class	BenchmarkResults
	Class used to store benchmark results. More...
class	BenchResult
class	BenchSuiteResult
class	ForceInstructionSets
class	IPSDKBenchmarkToolsException
	Exception class for library IPSDKBenchmarkTools. More...

Typedefs
typedef void(*	CustomizeConfigurationFun) (ipsdk::core::LibraryUserConfiguration &libraryUserConfiguration)
	function type used to customize benchmark configuration
typedef boost::shared_ptr< BenchmarkResultInfo >	ResultInfoPtr
	shared pointer to benchmark result information
typedef boost::shared_ptr< BaseBenchCase >	BenchCasePtr
	shared pointer to benchmark case
typedef boost::shared_ptr< BaseBenchSuite >	BenchSuitePtr
	shared pointer to benchmark suite

Enumerations
enum	eBMInternalDirectory {   eBMID_Config, eBMID_ConfigCommon, eBMID_Res, eBMID_Data,   eBMID_DataCommon, eBMID_Images, eBMID_ImagesCommon }
	Enumerate describing IPSDK internal benchmark directories. More...
enum	eBMExternalDirectory { eBMED_Results, eBMED_Tmp }
enum	eIPSDKBenchmarkToolsMessage {   eBenchCaseExecutionFailed, eBenchCaseResultBenchTestCollToolTipId, eBenchCaseResultNameToolTipId, eBenchCaseResultToolTipId,   eBenchCaseResultToolTipToolTipId, eBenchResultDurationToolTipId, eBenchResultInfoToolTipId, eBenchResultReadFail,   eBenchResultToolTipId, eBenchSuiteExecutionFailed, eBenchSuiteResultBenchCaseCollToolTipId, eBenchSuiteResultNameToolTipId,   eBenchSuiteResultToolTipId, eBenchSuiteResultToolTipToolTipId, eBenchmarkEnd, eBenchmarkExecFailed,   eBenchmarkExecutionFailed, eBenchmarkInitFailed, eBenchmarkInitInfo, eBenchmarkResultBenchSuiteCollToolTipId,   eBenchmarkResultInfo, eBenchmarkResultNameToolTipId, eBenchmarkResultToolTipId, eBenchmarkWriteInfoFailed,   eBenchmarkWriteResultFailed, eCanFindUserDataDirectory, eCanRetrieveComputerInfo, eEnteringBenchmark,   eExceptionRequestingRemoteBenchmarkInfo, eExecutionException, eFailedToCreateDir, eFailedToInitLibrary,   eFailedToOpenHtmlOutputFile, eFailedToOpenReport, eInfoFilePath, eResultFilePath,   eUnHandleEnumValue }
	Enumerate describing messages. More...

Functions
boost::filesystem::path	getBMConfigPath ()
	retrieve unit test configuration directory
boost::filesystem::path	getBMConfigCommonPath ()
	retrieve unit test configuration common directory
boost::filesystem::path	getBMDataPath ()
	retrieve unit test data directory
boost::filesystem::path	getBMDataCommonPath ()
	retrieve unit test data common directory
boost::filesystem::path	getBMImagesPath ()
	retrieve unit test images directory
boost::filesystem::path	getBMImagesCommonPath ()
	retrieve unit test images common directory
boost::filesystem::path	getBMResultsPath ()
	retrieve unit test results directory
boost::filesystem::path	getBMTmpPath ()
	retrieve unit test temporary directory
IPSDKBENCHMARKTOOLS_API ipsdk::ipInt32	runBenchmarks (const std::string &benchmarkName, CustomizeConfigurationFun pCustomizeConfiguration, int argc, char **argv)
	function allowing to execute benchmark tests More...
IPSDKBENCHMARKTOOLS_API boost::filesystem::path	getInternalDirectory (const eBMInternalDirectory &dirId)
	retrieve benchmark internal directory More...
IPSDKBENCHMARKTOOLS_API boost::filesystem::path	getExternalDirectory (const eBMExternalDirectory &dirId)
	retrieve benchmark external directory More...
IPSDKBENCHMARKTOOLS_API boost::filesystem::path	getBenchOutputDir ()
	function allowing to retrieve benchmark output directory
IPSDKBENCHMARKTOOLS_API void	initBenchmarck (const std::string &benchmarkName)
	function allowing to initialize library benchmark
IPSDKBENCHMARKTOOLS_API void	addBenchResult (const std::string &benchInfoStr, double duration)
	function allowing to add a benchmark result
IPSDKBENCHMARKTOOLS_API void	endBenchmarck ()
	function allowing to end library benchmark
IPSDKBENCHMARKTOOLS_API BoolResult	requestRemoteBenchmarkInfo (const std::string &ipAddress, unsigned short nPortNumber, BenchmarkInfo &remoteBenchmarkInfo, const boost::posix_time::time_duration &expiryDuration)
	function reading a BenchmarkInfo from a remote machine through sockets
IPSDKBENCHMARKTOOLS_API void	waitForRemoteBenchmarkInfoRequest (unsigned short nPortNumber)
	function sending a BenchmarkInfo to a remote machine through sockets
IPSDKBENCHMARKTOOLS_API const std::string &	getIPSDKBenchmarkToolsLoggerName ()
	Recovery of logger name associated to library.
IPSDKBENCHMARKTOOLS_API log4cplus::Logger &	getIPSDKBenchmarkToolsLogger ()
	Recovery of logger associated to library.
IPSDKBENCHMARKTOOLS_API const ipsdk::LogMessageManager &	getIPSDKBenchmarkToolsLogMessageManager ()
	Recovery of message manager associated to library.

Detailed Description

Namespace agregating IPSDK benchmark routines and classes.

Enumeration Type Documentation

eBMInternalDirectory

enum ipsdk::bench::eBMInternalDirectory

Enumerate describing IPSDK internal benchmark directories.

Note

This object is associated to a strong enumerate definition

See also

IPSDK_Enum

Enumerator
eBMID_Config	Benchmark configuration root directory.
eBMID_ConfigCommon	Benchmark configuration common directory.
eBMID_Res	Benchmark resource directory.
eBMID_Data	Benchmark data root directory.
eBMID_DataCommon	Benchmark data common directory.
eBMID_Images	Benchmark images root directory.
eBMID_ImagesCommon	Benchmark images common directory.

eBMExternalDirectory

enum ipsdk::bench::eBMExternalDirectory

Enumerator
eBMED_Results	Benchmark results root directory.
eBMED_Tmp	Benchmark temporary root directory.

eIPSDKBenchmarkToolsMessage

enum ipsdk::bench::eIPSDKBenchmarkToolsMessage

Enumerate describing messages.

Note

This enumerate is associated to a message map

See also

IPSDK_Message_Map

Enumerator
eBenchCaseExecutionFailed	Benchmark case s::s execution failed s.
eBenchCaseResultBenchTestCollToolTipId	Collection of bench test results for benchmark case.
eBenchCaseResultNameToolTipId	Name associated to benchmark case.
eBenchCaseResultToolTipId	Result structure for benchmark case result.
eBenchCaseResultToolTipToolTipId	ToolTip associated to benchmark case.
eBenchResultDurationToolTipId	Duration of benchmark result in milliseconds.
eBenchResultInfoToolTipId	Information string on benchmark result.
eBenchResultReadFail	Failed to read results for benchmark s s.
eBenchResultToolTipId	Result structure for benchmark result.
eBenchSuiteExecutionFailed	Benchmark suite s execution failed s.
eBenchSuiteResultBenchCaseCollToolTipId	Collection of bench case results for benchmark suite.
eBenchSuiteResultNameToolTipId	Name associated to benchmark suite.
eBenchSuiteResultToolTipId	Result structure for benchmark suite result.
eBenchSuiteResultToolTipToolTipId	ToolTip associated to benchmark suite.
eBenchmarkEnd	End of benchmark s.
eBenchmarkExecFailed	Benchmark execution failed s.
eBenchmarkExecutionFailed	Benchmark s execution failed s.
eBenchmarkInitFailed	Failed to initialized benchmark s.
eBenchmarkInitInfo	Benchmark s directory : s.
eBenchmarkResultBenchSuiteCollToolTipId	Collection of bench suite results for full benchmark.
eBenchmarkResultInfo	[f] : s
eBenchmarkResultNameToolTipId	Name associated to full benchmark.
eBenchmarkResultToolTipId	Result structure for full benchmark results.
eBenchmarkWriteInfoFailed	Failed to write benchmark information to file s s.
eBenchmarkWriteResultFailed	Failed to write benchmark results to file s s.
eCanFindUserDataDirectory	Can't find user data directory : s.
eCanRetrieveComputerInfo	Can't retrieve local computer informations s.
eEnteringBenchmark	Entering benchmark s.
eExceptionRequestingRemoteBenchmarkInfo	Error requestiong remote benchmark info: s.
eExecutionException	An exception has been throw during execution of benchmark s::ss s.
eFailedToCreateDir	Failed to create output results directory s.
eFailedToInitLibrary	Failed to initialize library for benchmarks tests s.
eFailedToOpenHtmlOutputFile	Failed to open html ouput file s.
eFailedToOpenReport	Failed to open html report file s s.
eInfoFilePath	Information file path for benchmark is given by s.
eResultFilePath	Result file path for benchmark is given by s.
eUnHandleEnumValue	Unhandle enumerate value s.

Function Documentation

runBenchmarks()

IPSDKBENCHMARKTOOLS_API ipsdk::ipInt32 ipsdk::bench::runBenchmarks	(	const std::string &	benchmarkName,
		CustomizeConfigurationFun	pCustomizeConfiguration,
		int	argc,
		char **	argv
	)

function allowing to execute benchmark tests

Returns

execution error code

getInternalDirectory()

IPSDKBENCHMARKTOOLS_API boost::filesystem::path ipsdk::bench::getInternalDirectory

(

const eBMInternalDirectory &

dirId

)

retrieve benchmark internal directory

Exceptions

ipsdk::bench::BenchmarkToolsException

if failed to retrieve directory

getExternalDirectory()

IPSDKBENCHMARKTOOLS_API boost::filesystem::path ipsdk::bench::getExternalDirectory

(

const eBMExternalDirectory &

dirId

)

retrieve benchmark external directory

Exceptions

ipsdk::bench::BenchmarkToolsException

if failed to retrieve directory