EdiabasResult¶

class EdiabasResult¶

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:

EdiabasResult

DeactivateEdiabasOption()¶

Deactivates the ediabas option.

DeactivateSaveIn()¶

Deactivates the save in variable option.

GetComment()¶

Returns the comment of the result.

Returns:

Comment of the result

Return type:

str

GetExpectation()¶

Returns the expectation of the result.

Returns:

Expectation of the result

Return type:

Expectation

GetName()¶

Returns the name of the result.

Returns:

Name of the result

Return type:

str

GetOptionHighlightGroup()¶

Returns the highlight group option of the ‘GROUP’ option type.

Returns:

Whether the group of the result set will be highlighted when successful.

Return type:

boolean

GetOptionResultSet()¶

Returns the result set of the ‘CHOICE’ option type. That result set must fulfill the expectation.

Returns:

Result set

Return type:

integer

GetOptionType()¶

Returns the option type of the result.

Returns:

Option type. One of [u’ALL’, u’EXIST’, u’CHOICE’, u’GROUP’]. ‘ALL’: Must be fulfilled in every result set ‘EXIST’: Must be fulfilled in at least one result set ‘CHOICE’: Must be fulfilled in the selected result set ‘GROUP’: Must be fulfilled together with other results

Return type:

str

GetSaveInVariableName()¶

Returns the save in variable name.

Returns:

Variable name

Return type:

str

GetType()¶

Returns the type of the result.

Returns:

Type of the result

Return type:

str

IsCheckTypeEnabled()¶

Returns whether the type will be checked or not.

Returns:

Whether the type will be checked or not. Returns None if no ediabas option is set.

Return type:

boolean

IsChecked()¶

Returns whether the result is checked or not.

Returns:

Whether the result is checked or not (optional, defaults to True)

Return type:

boolean

IsDynamic()¶

Returns whether the result is dynamic or not.

Returns:

Whether the result is dynamic or not.

Return type:

boolean

IsSelfDefined()¶

Returns whether the result is self defined or not.

Returns:

Whether the result is self defined or not.

Return type:

boolean

SetCheckType(checkType=True)¶

Sets whether the type will be checked or not.

Parameters:

checkType : boolean¶

Whether the type will be checked or not. Optional, defaults to True.

Raises:

ApiError: The EDIABAS option is not defined

SetChecked(checked=True)¶

Sets whether the result is checked or not.

Parameters:

checked : boolean¶

Whether the result is checked or not (optional, defaults to True)

SetComment(comment)¶

Sets the comment of the result. This can only be used with self defined results. Use IsSelfDefined to check whether a result is self defined.

Parameters:

comment : str¶

Result comment

Raises:

ApiError: If called on a result that is not self defined.

SetExpectation(exp)¶

Sets the expectation of the result.

Parameters:

exp¶

Expectation of the result

Raises:

ApiError: If the parameter exp is not if type Expectation.

SetOptionHighlightGroup(highlight=True)¶

Sets the highlight group option of the ‘GROUP’ option type. The option type will be set to ‘GROUP’ if it is not already.

Parameters:

highlight : boolean¶

Whether the group of the result set will be highlighted when successful.

SetOptionResultSet(resultSet)¶

Sets the result set of the ‘CHOICE’ option type. That result set must fulfill the expectation. The option type will be set to ‘CHOICE’ if it is not already.

Parameters:

resultSet : integer¶

Result set

Raises:

ApiError: If the parameter resultSet is not >=0.

SetOptionType(optionType)¶

Sets the option type of the result. Existing option settings like the expression and type checking will be kept. The Ediabas option will be activated if it is not already.

Parameters:

optionType : str¶

Option type. Must be one of [u’ALL’, u’EXIST’, u’CHOICE’, u’GROUP’]. ‘ALL’: Must be fulfilled in every result set ‘EXIST’: Must be fulfilled in at least one result set ‘CHOICE’: Must be fulfilled in the selected result set ‘GROUP’: Must be fulfilled together with other results

Raises:

ApiError: If the parameter optionType is not one of [u’ALL’, u’EXIST’, u’CHOICE’, u’GROUP’].

SetSaveInVariableName(varName)¶

Sets the save in variable name.

Parameters:

varName : str¶

Variable name

Raises:

ApiError: If the test step is not added to a package.

SetType(resType)¶

Sets the type of the result. This can only be used with self defined results. Use IsSelfDefined to check whether a result is self defined.

Parameters:

resType : str¶

Result type. Must be one of [u’binary’, u’string’, u’char’, u’unsigned char’, u’int’, u’unsigned int’, u’long’, u’unsigned long’, u’real’]

Raises:

ApiError: - When the result is not a self defined result. - When the result type is invalid.