Parameter Set Generator API - API documentation

class ParamGenerator¶

This is the base class for user-defined parameter generators and all implementations should be derived from this class. It defines specific methods that are called during generation of parameter sets. The desired behavior of a parameter generator is achieved by overwriting the methods provided for this purpose.

Some fields and methods must be overridden (mandatory), others may be overridden (optional). There are also methods that are only to be called by the user implementation and should not be overridden (those without a note).

DESCRIPTION = ''¶

A short description of the parameter generator.

Type:: str

Info

Setting this field is optional

ID = ''¶

A universally unique identifier to make the parameter generator unique. The ID should be generated using a UUID generator to be unique.

Type:: str

Info

Setting this field is mandatory

NAME = ''¶

The display name of the parameter generator.

Type:: str

Info

Setting this field is mandatory

SERIALIZE : dict[str, tuple[str, str] | tuple[str, str, object]] = {}¶

Declaration of instance variables of the parameter generator, that are to be exported/imported to/from xml format (e.g. during saving/loading a project). The declaration contains an item for each instance variable in form of an dictionary. Example:

SERIALIZE = {
                "foo": ("FOO-VAR", "integer", 23),
                "bar": ("BAR", "string"),
                "params: ("PARAMETERS", "list")
            }

The declaration items key must match the name of the corresponding instance variable (e.g. for an instance variable self.foo the item’s key must be “foo”). The item’s value must be a tuple containing at least 2 elements. So the general syntax for a declaration item is:

``<variable name>: (<variable alias>, <type alias>, [default value])``

Syntax and meaning of the tuple’s elements are:

<variable alias> declares the name of the xml element that is used for the variable’s xml representation.
<type alias> keyword specifing the python variable’s type. The following table gives all keywords and their corresponding python type respectively:
- boolean: bool
- integer: int
- long: int
- float: float
- string: str
- unicode: str
- list: list
- dict: dict

PLEASE NOTE: Keys of dictionaries being (de-)serialized must be strings. Furthermore values of dictionaries and lists are required to be of type bool, int, float, str, list or dict. The same restrictions apply to embedded lists and dictionaries. The types long and unicode are only kept for compatibility. Do not use these in new code.

<default value> is an optional element. It specifies the variable’s default value. If the variable’s value equals its default value during export the variable is not exported at all. Conversely, the variable is assigned its default value during import if the xml data does not provide an value for the variable.

Type:: dict

Info

Setting this field is optional

api = None¶: Access to the internal ecu.test API. The API will be assigned at runtime, in order to be independent from ecu.test for testing purposes.

See also

Internal APIs

projectPath : str | None = None¶: Absolute path to the project file containing the generator. In case of direct execution, this is the source project. In case of static generation it is the destination project.

classmethod GetDescription()¶

Returns the description of the parameter generator. The description can be specified by setting the class variable DESCRIPTION.

Return type:: str

classmethod GetId()¶

Returns the universally unique identifier of the parameter generator. The identifier should be specified by setting the class variable ID.

Return type:: str

classmethod GetName()¶

Returns the name of the parameter generator. The name should be specified by setting the class variable NAME.

Return type:: str

Check()¶

Implement this method to allow the user-implemented generator to be checked.

Returns:: A list of error messages or an empty list if everything is fine.
Return type:: list<str>

Info

Overriding this method is optional.

CreateCycleData(paramSet=None, constSet=None, name=None)¶

Method, to create an instance of class CycleData.

Parameters:

paramSet : dict¶: A set of parameters to parameterize a package.
constSet : dict¶: A set of constants that will be set before running a package. (optional)
name : str¶: A name for this cycle that will be displayed in the report. (optional)

Returns:

The cycle data object

Return type:

CycleData

DryGenerationEnabled()¶

Returns True, if the generator runs in dry generation mode. In this mode, the generator is used to generate a project with static parameter records.

Return type:: bool

GenerationIterator()¶

Implement this method for generating parameter sets. Each parameter set must be an object of CycleData and can be created with the method CreateCycleData(). Since this is a python iterator, the parameter sets must be returned with the keyword ‘yield’. Either a single parameter set or a list of parameter sets can be yielded.

Example:

def GenerationIterator(self):
    for line in file:
        yield CreateCycleData({'lineData': line})

Info

Overriding this method is mandatory

GetDialog()¶

Implement this method to return the configuration dialog of your parameter generator. The dialog should set the generator data.

Return type:: wx.Dialog or None

Info

Overriding this method is optional.

GetLastReturnSet()¶

Returns the return set of the last package execution.

This method only returns a result if the generator is not running in dry generation mode and it is called within the GenerationIterator() method after at least one parameter set has been executed (by a yield in the GenerationIterator() method). In all other circumstances, the method always returns None.

Return type:: dict, None

GetParameterText()¶

Implement this method to show the parameters of your param generator in properties column.

Returns:: parameter text
Return type:: str

Info

Overriding this method is optional.

GetReportData()¶

Implement this method to set the information for the generator test step in the report. An object of type ReportData must be returned.

Return type:: ReportData or None

Info

Overriding this method is optional.

GetTargetItemCount()¶

Implement this method to define the expected number of cycle sets to be generated as information for progress indicators. Will be called for updates throughout the generation. Therefore, you can dynamically return the size of the current task.

Returns:: expected count of cycle sets to be generated
Return type:: int

GetUsedMappingItems()¶

Returns the mapping items that will be used during generation.

If mapping items are to be added to the generated parameter sets of an analysis package, they have to be defined here in order to be registered for the stimulation package. Mapping items can be defined here directly, parsed from a file or whatever source, but the complete set of mapping items used during generation has to be returned by this method.

Info

Overriding this method is optional and only necessary for parameter set generators used with analysis packages and overwriting mapping items.

Caution

This method is called before any other method (e.g., PreGeneration)! If you read in required data for the mapping during PreGeneration, you have to redesign your code to be called at least once during GetUsedMappingItems.

Returns:: list of mapping items
Return type:: list[ApiClient.MappingItem]

IsValidForAnalysisPackages()¶

Returns if usage of parameter set generator is feasible for analysis packages.

If set to ‘True’ and parameter set generator is not feasible for analysis packages, errors will be raised during runtime. If set to ‘False’, the GUI will give direct feedback if the parameter set generator is used for an analysis package.

Returns:: True, if valid for analysis package usage, else False
Return type:: bool

Info

Overriding this method is optional.

OnInit(packageInfo)¶

Implement this method to process information about the package to which the generator belongs. It will be called before PreGeneration() or GetDialog() is called.

Parameters:

packageInfo¶: The package info object.

Info

Overriding this method is optional

PostGeneration()¶: Implement this method to specify post generation behavior. This method is called after the generation. This method will be called even if an exception occurs during generation (incl. PreGeneration), but not if the project execution is aborted (by the user or because of an “abort on error” setting).

Info

Overriding this method is optional.

PreGeneration()¶: Implement this method to specify pre generation behavior. This method is called before the generation.

Info

Overriding this method is optional.

class AbortError¶

class CallbackParamGenerator¶

This is an alternative base class for user-defined parameter generators. The interface corresponds to that of the ParamGenerator class with the only difference that the Generate method must be implemented instead of the GenerationIterator method.

DESCRIPTION = ''¶

A short description of the parameter generator.

Type:: str

Info

Setting this field is optional

ID = ''¶

A universally unique identifier to make the parameter generator unique. The ID should be generated using a UUID generator to be unique.

Type:: str

Info

Setting this field is mandatory

NAME = ''¶

The display name of the parameter generator.

Type:: str

Info

Setting this field is mandatory

SERIALIZE : dict[str, tuple[str, str] | tuple[str, str, object]] = {}¶

Declaration of instance variables of the parameter generator, that are to be exported/imported to/from xml format (e.g. during saving/loading a project). The declaration contains an item for each instance variable in form of an dictionary. Example:

SERIALIZE = {
                "foo": ("FOO-VAR", "integer", 23),
                "bar": ("BAR", "string"),
                "params: ("PARAMETERS", "list")
            }

The declaration items key must match the name of the corresponding instance variable (e.g. for an instance variable self.foo the item’s key must be “foo”). The item’s value must be a tuple containing at least 2 elements. So the general syntax for a declaration item is:

``<variable name>: (<variable alias>, <type alias>, [default value])``

Syntax and meaning of the tuple’s elements are:

<variable alias> declares the name of the xml element that is used for the variable’s xml representation.
<type alias> keyword specifing the python variable’s type. The following table gives all keywords and their corresponding python type respectively:
- boolean: bool
- integer: int
- long: long
- float: float
- string: str
- unicode: str
- list: list
- dict: dict

PLEASE NOTE: Keys of dictionaries being (de-)serialized must be strings. Furthermore values of dictionaries and lists are required to be of type bool, int, float, str, list or dict. The same restrictions apply to embedded lists and dictionaries. The types long and unicode are only kept for compatibility. Do not use these in new code.

<default value> is an optional element. It specifies the variable’s default value. If the variable’s value equals its default value during export the variable is not exported at all. Conversely, the variable is assigned its default value during import if the xml data does not provide an value for the variable.

Type:: dict

Info

Setting this field is optional

api = None¶: Access to the internal ecu.test API. The API will be assigned at runtime, in order to be independent from ecu.test for testing purposes.

See also

Internal APIs

projectPath : str | None = None¶: Absolute path to the project file containing the generator. In case of direct execution, this is the source project. In case of static generation it is the destination project.

classmethod GetDescription()¶

Returns the description of the parameter generator. The description can be specified by setting the class variable DESCRIPTION.

Return type:: str

classmethod GetId()¶

Returns the universally unique identifier of the parameter generator. The identifier should be specified by setting the class variable ID.

Return type:: str

classmethod GetName()¶

Returns the name of the parameter generator. The name should be specified by setting the class variable NAME.

Return type:: str

Check()¶

Implement this method to allow the user-implemented generator to be checked.

Returns:: A list of error messages or an empty list if everything is fine.
Return type:: list<str>

Info

Overriding this method is optional.

CreateCycleData(paramSet=None, constSet=None, name=None)¶

Method, to create an instance of class CycleData.

Parameters:

paramSet : dict¶: A set of parameters to parameterize a package.
constSet : dict¶: A set of constants that will be set before running a package. (optional)
name : str¶: A name for this cycle that will be displayed in the report. (optional)

Returns:

The cycle data object

Return type:

CycleData

DryGenerationEnabled()¶

Returns True, if the generator runs in dry generation mode. In this mode, the generator is used to generate a project with static parameter records.

Return type:: bool

Generate(testRunFunction)¶

Implement this method for generating parameter sets. Each parameter set must be an object of CycleData and can be created with the method CreateCycleData(). A test run is executed by calling the testRunFunction.

Parameters:

testRunFunction¶: If this function is called, an ecu.test test run is started. The function expects one or more parameter sets and returns a list of dictionaries containing the return variables of the package with their result values. A parameter set must be an instance of CycleData which can be created with the method CreateCycleData(). If the test run is aborted by ecu.test, an abort error occurs. This error should only be caught for the purpose of cleaning up.

Info

Overriding this method is mandatory

GetDialog()¶

Implement this method to return the configuration dialog of your parameter generator. The dialog should set the generator data.

Return type:: wx.Dialog or None

Info

Overriding this method is optional.

GetLastReturnSets()¶

Returns a list of all return sets from the last ecu.test test run.

This method only returns a result if the generator is not running in dry generation mode and it is called within the L{Generate()} method after at least one parameter set has been executed (by calling the testRunFunction in the L{Generate()} method). In all other circumstances, the method always returns an empty list.

Return type:: list of dicts

GetParameterText()¶

Implement this method to show the parameters of your param generator in properties column.

Returns:: parameter text
Return type:: str

Info

Overriding this method is optional.

GetReportData()¶

Implement this method to set the information for the generator test step in the report. An object of type ReportData must be returned.

Return type:: ReportData or None

Info

Overriding this method is optional.

GetTargetItemCount()¶

Implement this method to define the expected number of cycle sets to be generated as information for progress indicators. Will be called for updates throughout the generation. Therefore, you can dynamically return the size of the current task.

Returns:: expected count of cycle sets to be generated
Return type:: int

GetUsedMappingItems()¶

Returns the mapping items that will be used during generation.

If mapping items are to be added to the generated parameter sets of an analysis package, they have to be defined here in order to be registered for the stimulation package. Mapping items can be defined here directly, parsed from a file or whatever source, but the complete set of mapping items used during generation has to be returned by this method.

Info

Overriding this method is optional and only necessary for parameter set generators used with analysis packages and overwriting mapping items.

Caution

This method is called before any other method (e.g., PreGeneration)! If you read in required data for the mapping during PreGeneration, you have to redesign your code to be called at least once during GetUsedMappingItems.

Returns:: list of mapping items
Return type:: list[ApiClient.MappingItem]

IsValidForAnalysisPackages()¶

Returns if usage of parameter set generator is feasible for analysis packages.

If set to ‘True’ and parameter set generator is not feasible for analysis packages, errors will be raised during runtime. If set to ‘False’, the GUI will give direct feedback if the parameter set generator is used for an analysis package.

Returns:: True, if valid for analysis package usage, else False
Return type:: bool

Info

Overriding this method is optional.

OnInit(packageInfo)¶

Implement this method to process information about the package to which the generator belongs. It will be called before PreGeneration() or GetDialog() is called.

Parameters:

packageInfo¶: The package info object.

Info

Overriding this method is optional

PostGeneration()¶: Implement this method to specify post generation behavior. This method is called after the generation. This method will be called even if an exception occurs during generation (incl. PreGeneration), but not if the project execution is aborted (by the user or because of an “abort on error” setting).

Info

Overriding this method is optional.

PreGeneration()¶: Implement this method to specify pre generation behavior. This method is called before the generation.

Info

Overriding this method is optional.

class CycleData¶

This class is a container for all data, that can be generated during one cycle.

RECORDING_INFO_CLASS¶: alias of RecordingInfo

Attributes¶

Returns the dict of attributes.

Returns:: The dict of attributes
Return type:: dict

ConstSet¶

Returns the set of constants.

Returns:: The set of constants.
Return type:: dict

Name¶

Returns the name of this cycle

Returns:: The name of this cycle
Return type:: str

ParamSet¶

Returns the set of parameters.

Returns:: The set of parameters.
Return type:: dict

RecordingInfos¶

Returns the dict of recording infos.

Returns:: The dict of recording infos.
Return type:: dict

AddAttribute(name, value)¶

Adds an attribute to this cycle.

Parameters:

name : str¶: Name of the attribute
value : str¶: Value of the attribute

AddConst(name, value)¶

Adds a constant to this cycle.

Parameters:

name : str¶: Name for the constant.
value : str | float | int | bool¶: Value to assign to this constant.

AddMappingItem(mappingItem)¶

Adds mapping item to the mapping space for this cycle.

See also

Object API

Parameters:

mappingItem : ApiClient.MappingItem¶: MappingItem originating from e.g api.GetObjectApi().PackageApi.MappingApi

AddParameter(name, value)¶

Adds a parameter to this cycle.

Parameters:

name : str¶: Name for the parameter.
value : str | float | int | bool¶: Value to assign to this parameter.

AddRecordingInfo(recordingGroupName, path)¶

Adds a recording info into a recording group for this cycle. A recording info consists of a recording (path) and some additional information depending on the recording type. The method returns a recording info object, so the additional information can be specified in this object.

Parameters:

recordingGroupName : str¶: Name of the recording group.
path : str¶: Path to the recording.

Returns:

The recording info object.

Return type:

RecordingInfo

GetAttributes()¶

Returns the dict of attributes.

Returns:: The dict of attributes
Return type:: dict

GetConstSet()¶

Returns the set of constants.

Returns:: The set of constants.
Return type:: dict

GetName()¶

Returns the name of this cycle

Returns:: The name of this cycle
Return type:: str

GetParamSet()¶

Returns the set of parameters.

Returns:: The set of parameters.
Return type:: dict

GetRecordingInfos()¶

Returns the dict of recording infos.

Returns:: The dict of recording infos.
Return type:: dict

SetName(value)¶

Sets the name of this cycle.

Parameters:

value : str¶: Name for this cycle.

UpdateAttribute(name, value)¶

Update an attribute

Parameters:

name : str¶: Name of the attribute
value : str¶: Value of the attribute

class OptimizerBase¶

This is the base class for user-defined optimizers. The class is based on the CallbackParamGenerator and extends its functionality with new features:

Management of minimum and maximum values for the package parameters
Optional parameter variation before the actual optimization
A dialog for managing minimum and maximum values, parameter variation and optimizer-specific settings

If a parameter variation is activated, it is executed after calling PreGeneration and before calling Generate. With GetVariationResults the results of the variation can be accessed in the Generate method.

DESCRIPTION = ''¶

A short description of the parameter generator.

Type:: str

Info

Setting this field is optional

ENABLE_PARAMETER_VARIATION = True¶

Enables or disables the support of a parameter variation before the optimization starts.

Type:: boolean

ID = ''¶

A universally unique identifier to make the parameter generator unique. The ID should be generated using a UUID generator to be unique.

Type:: str

Info

Setting this field is mandatory

NAME = ''¶

The display name of the parameter generator.

Type:: str

Info

Setting this field is mandatory

SERIALIZE : dict[str, tuple[str, str] | tuple[str, str, object]] = {}¶

Declaration of instance variables of the parameter generator, that are to be exported/imported to/from xml format (e.g. during saving/loading a project). The declaration contains an item for each instance variable in form of an dictionary. Example:

SERIALIZE = {
                "foo": ("FOO-VAR", "integer", 23),
                "bar": ("BAR", "string"),
                "params: ("PARAMETERS", "list")
            }

The declaration items key must match the name of the corresponding instance variable (e.g. for an instance variable self.foo the item’s key must be “foo”). The item’s value must be a tuple containing at least 2 elements. So the general syntax for a declaration item is:

``<variable name>: (<variable alias>, <type alias>, [default value])``

Syntax and meaning of the tuple’s elements are:

<variable alias> declares the name of the xml element that is used for the variable’s xml representation.
<type alias> keyword specifing the python variable’s type. The following table gives all keywords and their corresponding python type respectively:
- boolean: bool
- integer: int
- long: long
- float: float
- string: str
- unicode: str

PLEASE NOTE: The types long and unicode are only kept for compatibility. Do not use these in new code.

<default value> is an optional element. It specifies the variable’s default value. If the variable’s value equals its default value during export the variable is not exported at all. Conversely, the variable is assigned its default value during import if the xml data does not provide an value for the variable.

Type:: dict

Info

Setting this field is optional

api = None¶: Access to the internal ecu.test API. The API will be assigned at runtime, in order to be independent from ecu.test for testing purposes.

See also

Internal APIs

projectPath : str | None = None¶: Absolute path to the project file containing the generator. In case of direct execution, this is the source project. In case of static generation it is the destination project.

classmethod GetDescription()¶

Returns the description of the parameter generator. The description can be specified by setting the class variable DESCRIPTION.

Return type:: str

classmethod GetId()¶

Returns the universally unique identifier of the parameter generator. The identifier should be specified by setting the class variable ID.

Return type:: str

classmethod GetName()¶

Returns the name of the parameter generator. The name should be specified by setting the class variable NAME.

Return type:: str

Check()¶

Implement this method to allow the user-implemented generator to be checked.

Returns:: A list of error messages or an empty list if everything is fine.
Return type:: list<str>

Info

Overriding this method is optional.

CreateCycleData(paramSet=None, constSet=None, name=None)¶

Method, to create an instance of class CycleData.

Parameters:

paramSet : dict¶: A set of parameters to parameterize a package.
constSet : dict¶: A set of constants that will be set before running a package. (optional)
name : str¶: A name for this cycle that will be displayed in the report. (optional)

Returns:

The cycle data object

Return type:

CycleData

DryGenerationEnabled()¶

Returns True, if the generator runs in dry generation mode. In this mode, the generator is used to generate a project with static parameter records.

Return type:: bool

Generate(testRunFunction)¶

Implement this method for generating parameter sets. Each parameter set must be an object of CycleData and can be created with the method CreateCycleData(). A test run is executed by calling the testRunFunction.

Parameters:

testRunFunction¶: If this function is called, an ecu.test test run is started. The function expects one or more parameter sets and returns a list of dictionaries containing the return variables of the package with their result values. A parameter set must be an instance of CycleData which can be created with the method CreateCycleData(). If the test run is aborted by ecu.test, an abort error occurs. This error should only be caught for the purpose of cleaning up.

Info

Overriding this method is mandatory

GetDialog()¶

Implement this method to return the configuration dialog of your parameter generator. The dialog should set the generator data.

Return type:: wx.Dialog or None

Info

Overriding this method is optional.

GetLastReturnSets()¶

Returns a list of all return sets from the last ecu.test test run.

This method only returns a result if the generator is not running in dry generation mode and it is called within the L{Generate()} method after at least one parameter set has been executed (by calling the testRunFunction in the L{Generate()} method). In all other circumstances, the method always returns an empty list.

Return type:: list of dicts

GetMinMaxValues()¶

Returns the specified minimum and maximum values for the package parameters. A dictionary is returned with the parameter names as keys and lists with minimum and maximum as values. Example:

{'speed': [100, 120],
 'distance': [1000, 1500]
}

Return type:: dict

GetParameterText()¶

Implement this method to show the parameters of your param generator in properties column.

Returns:: parameter text
Return type:: str

Info

Overriding this method is optional.

GetReportData()¶

Implement this method to set the information for the generator test step in the report. An object of type ReportData must be returned.

Return type:: ReportData or None

Info

Overriding this method is optional.

GetTargetItemCount()¶

Implement this method to define the expected number of cycle sets to be generated as information for progress indicators. Will be called for updates throughout the generation. Therefore, you can dynamically return the size of the current task.

Returns:: expected count of cycle sets to be generated
Return type:: int

GetUsedMappingItems()¶

Returns the mapping items that will be used during generation.

If mapping items are to be added to the generated parameter sets of an analysis package, they have to be defined here in order to be registered for the stimulation package. Mapping items can be defined here directly, parsed from a file or whatever source, but the complete set of mapping items used during generation has to be returned by this method.

Info

Overriding this method is optional and only necessary for parameter set generators used with analysis packages and overwriting mapping items.

Caution

This method is called before any other method (e.g., PreGeneration)! If you read in required data for the mapping during PreGeneration, you have to redesign your code to be called at least once during GetUsedMappingItems.

Returns:: list of mapping items
Return type:: list[ApiClient.MappingItem]

GetVariationResults()¶

Returns the results of the parameter variation as a list of VariationResult objects. The method only returns results if it is called in the generator method and the parameter variation is activated. In all other circumstances, an empty list is returned.

Return type:: list<VariationResult>

IsValidForAnalysisPackages()¶

Returns if usage of parameter set generator is feasible for analysis packages.

If set to ‘True’ and parameter set generator is not feasible for analysis packages, errors will be raised during runtime. If set to ‘False’, the GUI will give direct feedback if the parameter set generator is used for an analysis package.

Returns:: True, if valid for analysis package usage, else False
Return type:: bool

Info

Overriding this method is optional.

OnInit(packageInfo)¶

Implement this method to process information about the package to which the generator belongs. It will be called before PreGeneration() or GetDialog() is called.

Parameters:

packageInfo¶: The package info object.

Info

Overriding this method is optional

PostGeneration()¶: Implement this method to specify post generation behavior. This method is called after the generation. This method will be called even if an exception occurs during generation (incl. PreGeneration), but not if the project execution is aborted (by the user or because of an “abort on error” setting).

Info

Overriding this method is optional.

PreGeneration()¶: Implement this method to specify pre generation behavior. This method is called before the generation.

Info

Overriding this method is optional.

class VariationResult¶

This class is a container for the input and result data of one variation.

CycleData¶

Returns the cycle data object that contains the input data for the variation.

Returns:: The cycle data object
Return type:: CycleData

ReturnSet¶

Returns the return set of the package execution for the variation.

Returns:: The return set as a dictionary
Return type:: dict, None

class PackageInfo¶

Provides information about a package, like name, variables, etc.

GetName()¶

Returns the package name.

Returns:: package name without extension
Return type:: str

GetParameterVariables()¶

Returns a list of all variables defined in the package and set as a parameter.

Returns:: List of all defined parameters
Return type:: list <Variable>

GetPath()¶

Returns the path of the package file as absolute path.

Returns:: absolute package path
Return type:: str

GetReturnVariables()¶

Returns a list of all variables defined in the package and set as a return variable.

Returns:: List of all defined return variables
Return type:: list <Variable>

GetVariables()¶

Returns a list of all variables defined in the package.

Returns:: List of all defined variables
Return type:: list <Variable>

class RecordingInfo¶

This class is a container for the information of a recording.

FormatDetails¶

Returns the format details of the recording.

Returns:: Format details of the recording.
Return type:: str

Path¶

Returns the path to the recording.

Returns:: Path to the recording.
Return type:: str

RecordingName¶

Returns the name of the recording.

Returns:: Name of the recording.
Return type:: str

RecordingNumber¶

Returns the number of the recording.

Returns:: Number of the recording.
Return type:: int

RecordingType¶

Returns the type of the recording.

Returns:: Type of the recording.
Return type:: str

GetFormatDetails()¶

Returns the format details of the recording.

Returns:: Format details of the recording.
Return type:: str

GetPath()¶

Returns the path to the recording.

Returns:: Path to the recording.
Return type:: str

GetRecordingName()¶

Returns the name of the recording.

Returns:: Name of the recording.
Return type:: str

GetRecordingNumber()¶

Returns the number of the recording.

Returns:: Number of the recording.
Return type:: int

GetRecordingType()¶

Returns the type of the recording.

Returns:: Type of the recording.
Return type:: str

SetFormatDetails(formatDetails)¶

Sets the format details of the recording.

Parameters:

formatDetails : str¶: Format details of the recording.

SetRecordingName(recordingName)¶

Sets the name of the recording.

Parameters:

recordingName : str¶: Name of the recording.

SetRecordingNumber(recordingNumber)¶

Sets the number of the recording.

Parameters:

recordingNumber : str¶: Number of the recording.

SetRecordingType(recordingType)¶

Sets the type of the recording.

Parameters:

recordingType : str¶: Type of the recording.

__init__(path)¶

Method, to initialize an instance of this class.

Parameters:

path : str¶: Path to the recording.

class ReportData¶

This class is a container for the information of the generator test step shown in the report

Comment¶

Returns the string for the comment column

Returns:: String for the comment column
Return type:: str

Value¶

Returns the string for the value column

Returns:: String for the value column
Return type:: str

GetComment()¶

Returns the string for the comment column

Returns:: String for the comment column
Return type:: str

GetValue()¶

Returns the string for the value column

Returns:: String for the value column
Return type:: str

SetComment(comment)¶

Sets the string for the comment column

Parameters:

comment : str¶: String for the comment column

SetValue(value)¶

Sets the string for the value column

Parameters:

value : str¶: String for the value column

class Variable

Description

returns the description of this variable.

Returns:: the description of this variable
Return type:: str

InitValue

returns the initial value of this variable.

Returns:: the initial value of this variable
Return type:: str

Name

returns the name of this variable.

Returns:: the name of this variable
Return type:: str

VariableType

Returns:: type of this variable
Return type:: str

GetDescription()

returns the description of this variable.

Returns:: the description of this variable
Return type:: str

GetInitValue()

returns the initial value of this variable.

Returns:: the initial value of this variable
Return type:: str

GetName()

returns the name of this variable.

Returns:: the name of this variable
Return type:: str

GetVariableType()

Returns:: type of this variable
Return type:: str

IsInput(): Returns True if this variable is an input parameter, otherwise False

IsOutput(): Returns True if this variable is an output parameter, otherwise False

class VariableType

Defines type of the variable.

Class var UNDEFINED:: ‘Undefined’
Class var NUMERIC:: ‘Numeric’
Class var STRING:: ‘String’
Class var ENUM:: ‘Enum’
Class var TEXTTABLE:: ‘Texttable’
Class var BOOL:: ‘Boolean’

class VariationResult

This class is a container for the input and result data of one variation.

CycleData

Returns the cycle data object that contains the input data for the variation.

Returns:: The cycle data object
Return type:: CycleData

ReturnSet

Returns the return set of the package execution for the variation.

Returns:: The return set as a dictionary
Return type:: dict, None

Parameter Set Generator API¶

ParamGenerator¶

AbortError¶

CallbackParamGenerator¶

CycleData¶

OptimizerBase¶

PackageInfo¶

RecordingInfo¶

ReportData¶

Variable¶

VariationResult¶