rambrain
testParameter< T > Class Template Reference

Class to encapsulate parameters given by type T. More...

#include <performanceTestClasses.h>

Inheritance diagram for testParameter< T >:
testParameterBase

Public Member Functions

virtual ~testParameter ()
 Cleanup. More...
 
virtual string valueAsString ()
 Cast the encapsulated parameter to a string and return it's mean value. More...
 
virtual string valueAsString (unsigned int step)
 Cast the encapsulated parameter to a string and return it's value at a certain step. More...
 
- Public Member Functions inherited from testParameterBase
virtual ~testParameterBase ()
 Cleanup. More...
 

Public Attributes

min
 
max
 
mean
 
- Public Attributes inherited from testParameterBase
unsigned int steps
 
bool deltaLog
 
string name
 
bool enabled = true
 

Protected Member Functions

valueAtStep (unsigned int step)
 Look up the parameter value at a certain step. More...
 
string toString (const T &t)
 Convert a value of the parameter type to a string. More...
 

Detailed Description

template<typename T>
class testParameter< T >

Class to encapsulate parameters given by type T.

Definition at line 76 of file performanceTestClasses.h.

Constructor & Destructor Documentation

template<typename T>
virtual testParameter< T >::~testParameter ( )
inlinevirtual

Cleanup.

Definition at line 83 of file performanceTestClasses.h.

Member Function Documentation

template<typename T>
string testParameter< T >::toString ( const T &  t)
inlineprotected

Convert a value of the parameter type to a string.

Parameters
tThe value
Returns
The string
Note
If this fails to compile overloading of the stringstream operator<< is required

Definition at line 125 of file performanceTestClasses.h.

template<typename T>
virtual string testParameter< T >::valueAsString ( )
inlinevirtual

Cast the encapsulated parameter to a string and return it's mean value.

Implements testParameterBase.

Definition at line 88 of file performanceTestClasses.h.

template<typename T>
virtual string testParameter< T >::valueAsString ( unsigned int  step)
inlinevirtual

Cast the encapsulated parameter to a string and return it's value at a certain step.

Parameters
stepThe step to take
Returns
min + (max - min) * step

Implements testParameterBase.

Definition at line 97 of file performanceTestClasses.h.

template<typename T>
T testParameter< T >::valueAtStep ( unsigned int  step)
inlineprotected

Look up the parameter value at a certain step.

Parameters
stepThe step
Returns
min + (max - min) * step

Definition at line 109 of file performanceTestClasses.h.

Member Data Documentation

template<typename T>
T testParameter< T >::max

Definition at line 101 of file performanceTestClasses.h.

template<typename T>
T testParameter< T >::mean

Definition at line 101 of file performanceTestClasses.h.

template<typename T>
T testParameter< T >::min

Definition at line 101 of file performanceTestClasses.h.


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