SourcePro® C++ API Reference Guide

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

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

Public Member Functions

 RWQEPerfTestDef ()
 
 RWQEPerfTestDef (const std::string &desc, size_t threads, uint64_t maxMilliseconds, uint64_t minIterations, uint64_t maxIterations, int64_t warmupIterations, uint64_t operations=1, uint64_t uid=0)
 
const std::string & getDescription () const
 
uint64_t getMaxIterations () const
 
uint64_t getMaxTime () const
 
uint64_t getMinIterations () const
 
uint64_t getOperations () const
 
size_t getThreads () const
 
uint64_t getUID () const
 
int64_t getWarmupIterations () const
 

Detailed Description

RWQEPerfTestDef encapsulates the parameters that describe a specific test instance.

Constructor & Destructor Documentation

RWQEPerfTestDef::RWQEPerfTestDef ( )
inline

Constructs a default TestDef instance. All values are initialized to 0.

RWQEPerfTestDef::RWQEPerfTestDef ( const std::string &  desc,
size_t  threads,
uint64_t  maxMilliseconds,
uint64_t  minIterations,
uint64_t  maxIterations,
int64_t  warmupIterations,
uint64_t  operations = 1,
uint64_t  uid = 0 
)
inline

Constructs a TestDef instance.

Parameters
descA description of the test.
threadsThe number of threads that should concurrently execute the test function.
maxMillisecondsThe maximum time (in milliseconds) the test should execute. This does not limit the execution of a single iteration, however it may limit the total number of iterations.
minIterationsThe minimum number of iterations required for a successful test. This value is not used by the test execution framework, however may be useful to any data analysis performed.
maxIterationsThe maximum number of iterations that should be performed.
warmupIterationsThe number of iterations that should be performed before timing data is gathered. These iterations will occur regardless of any limits set by maxMilliseconds.
operationsThe number of operations that each iteration will perform.
uidA unique identifier for each thread of test execution.

Member Function Documentation

const std::string & RWQEPerfTestDef::getDescription ( ) const
inline

The description of the test.

uint64_t RWQEPerfTestDef::getMaxIterations ( ) const
inline

The maximum number of iterations that should be performed.

uint64_t RWQEPerfTestDef::getMaxTime ( ) const
inline

The maximum amount of time allowed for all iterations.

uint64_t RWQEPerfTestDef::getMinIterations ( ) const
inline

The minimum number of iterations required to consider the test valid.

uint64_t RWQEPerfTestDef::getOperations ( ) const
inline

The number of operations to perform for each iteration.

size_t RWQEPerfTestDef::getThreads ( ) const
inline

The number of threads that are executed concurrently.

uint64_t RWQEPerfTestDef::getUID ( ) const
inline

The uid value for this test execution.

int64_t RWQEPerfTestDef::getWarmupIterations ( ) const
inline

The number of warmup iterations that should be executed before timing information is gathered.

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.