ParameterSetBase¶

class ParameterSetBase¶

Attributes¶

Returns access to the package attributes definitions specified within the parameter set and the referenced package attribute definition files.

Returns:: Package attribute interface of the parameter set
Return type:: Attributes

GlobalConstants¶

Returns access to the global constants definitions specified within the parameter set and the referenced global constants definition files.

Returns:: Global constants interface of the parameter set
Return type:: GlobalConstants

Mapping¶

Returns access to the mapping of the parameter set.

Returns:: Mapping interface of the parameter set
Return type:: ParameterSetMapping

MappingFiles¶

Returns access to the mapping file list of the parameter set.

Returns:: Mapping file list object of the parameter set
Return type:: MappingFiles

Parameters¶

Returns access to the package parameters definitions specified within the parameter set and the referenced package parameters definition files.

Returns:: Package parameters interface of the parameter set
Return type:: PackageParameters

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:: A copy of this object
Return type:: ParameterSetBase

GetIndex()¶

Returns the zero based index in the parent.

Returns:: Zero based index
Return type:: int

GetLineNo()¶

Returns the line number within its project.

Returns:: Line number
Return type:: int

GetName()¶

Returns the name of the project component.

Returns:: Name of the component
Return type:: str

GetPackage()¶

Returns the referenced package.

Note:: The returned package object is a reference. If this object is used to manipulate the content all references in this project are affected.
Returns:: The referenced package of type Package or the referenced analysis package of type AnalysisPackage
Return type:: PackageBase

GetParent()¶

Returns the parent project component.

Returns:: Parent component
Return type:: ProjectComponent

GetTestCaseId()¶

Returns the test case id of the parameter record.

Returns:: Test case id
Return type:: str

GetTestScriptId()¶

Returns the test script id of the corresponding package.

Returns:: Test script id
Return type:: str

GetType()¶

Returns the type (class name) of the project component, e.g.

“ConfigChange”
“ParameterSet”
“PackageCall”
“Project”
“PackageGenerator”

Returns:: Type (class name) of the project component
Return type:: str

IsEnabled()¶

Returns the state of the test step.

Returns:: True if test step is enabled, otherwise False
Return type:: bool

IsReported()¶

Returns whether the test step will be reported. If it has a parent test step, this function will only return true if both this test step and the parent test step should be reported.

Returns:: True if test step will be reported, otherwise False
Return type:: bool

RemoveFromProject()¶

Removes this component from the project.

Raises:: ApiError – if the component is not part of any project

SetEnabled(state=True)¶

Enable or disable the test step.

Parameters:

state : bool¶: True (=Default) to enable, False to disable the test step.

SetName(name)¶

Sets the name of the project component.

Parameters:

name : str¶: Name of the component

SetReported(state=True)¶

Enable or disable the reporting of the test step. If it has a parent test step, its reporting must also be enabled in order to have this test step appear in the report.

Parameters:

state : bool¶: True (=Default) to enable, False to disable the reporting of the test step.

SetTestCaseId(testCaseId)¶

Sets the independent test case id of the parameter record.

Parameters:

testCaseId : str¶: Test case id

Returns:

True if the update was successful

Return type:

boolean

GetPosition()¶

Returns the position in the parent project.

Returns:: parent position
Return type:: int

Deprecated since version 2024.4: Please use method GetLineNo instead.