SourcePro® C++ API Reference Guide

Product Documentation:
   SourcePro C++
Documentation Home
List of all members | Public Member Functions
RWQEPerfTestResult Struct Reference

#include <rw/rwtest/perf/RWQEPerfTestResult.h>

Public Member Functions

 RWQEPerfTestResult (unsigned long thread, int64_t iteration, uint64_t operationCount, uint64_t wallTime, uint64_t systemTime, uint64_t userTime, const std::string &error="")
 
const std::string & getError () const
 
int64_t getIteration () const
 
uint64_t getOperationCount () const
 
uint64_t getSystemTime () const
 
unsigned long getThread () const
 
uint64_t getUserTime () const
 
uint64_t getWallTime () const
 

Detailed Description

RWQEPerfTestResult encapsulates the results of a single test iteration.

Constructor & Destructor Documentation

RWQEPerfTestResult::RWQEPerfTestResult ( unsigned long  thread,
int64_t  iteration,
uint64_t  operationCount,
uint64_t  wallTime,
uint64_t  systemTime,
uint64_t  userTime,
const std::string &  error = "" 
)
inline

Constructs an TestResult instance.

Parameters
threadAn identifier for the thread that was executed.
iterationThe iteration of the test this result is associated with.
operationCountThe number of loops the test function was executed in the current iteration.
wallTimeThe elapsed wall clock time for the test iteration.
systemTimeThe elapsed system time for the test iteration.
userTimeThe elapsed user time for the test iteration.
errorA string description of any errors that occurred during the test iteration. An empty string implies that no errors occurred.

Member Function Documentation

const std::string & RWQEPerfTestResult::getError ( void  ) const
inline

The error message associated with this test iteration (if any). If no errors occurred, this function returns an empty string.

int64_t RWQEPerfTestResult::getIteration ( ) const
inline

The iteration this test result is associated with. A negative iteration indicates a warmup iteration.

uint64_t RWQEPerfTestResult::getOperationCount ( ) const
inline

The number of loops the test function was executed in the current iteration.

uint64_t RWQEPerfTestResult::getSystemTime ( ) const
inline

The elapsed system time for this test iteration.

unsigned long RWQEPerfTestResult::getThread ( ) const
inline

The thread identifier associated with this test result.

uint64_t RWQEPerfTestResult::getUserTime ( ) const
inline

The elapsed user time for this test iteration.

uint64_t RWQEPerfTestResult::getWallTime ( ) const
inline

The elapsed wall clock time for this test iteration.

Copyright © 2016 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.