Package autodesk_toxik :: Module debug :: Class PerfTestWrapper

Class PerfTestWrapper

 object --+    
          |    
Boost.Python.instance --+
              |
             PerfTestWrapper

This Python class wraps a C++ performance test class. Each test returned by getPerfTestList() is of this type.

Instance Methods

__init__(...)
Raises an exception This class cannot be instantiated from Python

__reduce__(...)
helper for pickle

execute(...)
Executes a single iteration of the test.

finalize(...)
This function shall release any resources taken by the test.

getName(...)

dict

getStats(...)
Returns: A dictionay of labels strings to result strings representing stats.

str

getType(...)
Returns: A string representing the type of test.

str

getUsage(...)
Returns: A human-readable string describing the test parameters.

initialize(...)
Initializes the test with the given paramters.

Inherited from Boost.Python.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties
Inherited from `object`: `__class__`

Method Details

init(...)
(Constructor)

Raises an exception This class cannot be instantiated from Python

Overrides: object.__init__

reduce(...)

helper for pickle

Overrides: object.__reduce__: (inherited documentation)

execute(...)

Executes a single iteration of the test. This method must be called before execute is called. It may also be called any number of times until finalize() is called.

getStats(...)

Returns: dict: A dictionay of labels strings to result strings representing stats. The labels are human-readble and describe the result strings.

getType(...)

Returns: str: A string representing the type of test. Currently, image processing tests are of type 'image-proc'. All unclassified tests are of type 'generic'. More types may be added in the future.

getUsage(...)

Returns: str: A human-readable string describing the test parameters. The parameters should then be passed to initialize().

initialize(...)

Initializes the test with the given paramters. The given parameters are a dictionary of string names to string values.

Parameters:

params (dict)