CaseDefNode¶

class CaseDefNode¶

AddTag(tag)¶

Add a specific tag to this step.

Parameters:

tag : str¶

The tag to be set

AppendTraceStep(traceStep)¶

Adds a trace step at the end of its children.

Parameters:

traceStep¶

Trace step to be added

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:

CaseDefNode

GetCaseValue()¶

Returns the constant expression used in the case node.

Returns:

Constant expression of the case node

Return type:

str

GetDescription()¶

Not available. A case node does not have a description.

Returns:

The description

Return type:

str

GetIndex()¶

Returns the zero based index in the parent.

Returns:

Zero based index

Return type:

int

GetLineNo()¶

Returns the trace steps line number within its trace analysis.

Returns:

Line number

Return type:

int

GetName()¶

Returns the name of the trace analysis element.

Returns:

The name

Return type:

str

GetTags()¶

Returns the tags set for this step.

Returns:

A (sorted) list of tags

Return type:

list[str]

GetTraceSteps(skipDisabledSteps=False, recursive=False)¶

Returns either direct or all children of the trace step.

Parameters:

skipDisabledSteps : boolean¶

Defines whether disabled trace steps should be excluded, defaults to False.

recursive : boolean¶

Defines whether children of children are included, defaults to False.

Returns:

The trace steps as flat list.

Return type:

list[TraceStep]

GetType()¶

Returns the type (class name) of the trace step, e.g.

• ‘Episode’

• ‘AnalysisBlock’

• ‘TriggerBlock’

• ‘Calculation’

• ‘TemplateBasedTraceStep’

• ‘TraceAnalysisReference’

• ‘TraceAnalysisReferenceDeprecated’

Returns:

Type (class name) of the trace step

Return type:

str

GetUuid()¶

Returns the UUID of the trace step.

Returns:

UUID of the trace step

Return type:

str

InsertTraceStep(traceStep, position)¶

Adds a trace step at a certain line of the trace analysis.

Parameters:

traceStep¶

Trace step to be added

position : integer¶

Target index of child beginning with 0

IsContainer()¶

Checks whether this trace step can contain trace steps.

Returns:

True if it can contain trace steps, else False

Return type:

boolean

IsDefaultNode()¶

Returns True if this is the default node.

Returns:

If default node

Return type:

bool

IsEnabled()¶

Checks whether the trace step is enabled.

Returns:

True if trace step is enabled, else False

Return type:

boolean

IsOk()¶

Returns the internal state of correctness of the trace step.

Returns:

True if no problems were found, else False

Return type:

boolean

IsVisible()¶

Checks whether the trace step is visible. This depends on the trace step itself or a parent trace step being disabled.

Returns:

True if trace step is visible, else False

Return type:

boolean

RemoveTag(tag)¶

Remove a specific tag from this step.

Parameters:

tag : str¶

The tag to be removed

RemoveTraceStep(traceStep)¶

Removes the given trace step from the trace analysis.

Parameters:

traceStep¶

Trace step to be removed

SetCaseValue(caseValue)¶

Sets the constant expression used in the case node.

Parameters:

caseValue : str¶

Constant expression of the caseDefNode block

SetDescription(value)¶

No operation. A case node does not have a description.

Parameters:

value : str¶

The new description

SetEnabled(enable)¶

No operation. A case node is automatically enabled or disabled by its case value and cannot be enabled or disabled by the user.

Parameters:

enable : boolean¶

If True, enables the trace step, if False, disables the trace step

SetName(name)¶

No operation. The name of a case node cannot be changed.

Parameters:

name : str¶

The new name

SetTags(tags)¶

Set the list of tags for this step. The list of tags will be sorted and stored.

Parameters:

tags : list[str]¶

The list of tags