RelayVariable¶
- class RelayVariable¶
Returned by
- 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:
- GetBufferSize()¶
Returns the buffer size of the relay, which corresponds to the number of messages that can be stored until the relay is connected to an inbox or another relay.
- Returns:
Size of the buffer or None if unlimited
- Return type:
int
- GetDescription()¶
Returns the description of the variable.
- Returns:
Description of variable
- Return type:
str
- GetName()¶
Returns the name of the variable.
- Returns:
Name of variable
- Return type:
str
- GetType()¶
Returns the type of the initial value of the variable.
- Returns:
type of the initial value
- Return type:
str
- IsOverflowErrorEnabled()¶
Returns whether overflow warning is enabled for the relay.
- Returns:
True if overflow warning is enabled, False otherwise
- Return type:
bool
- IsParameter()¶
Returns whether the variable is a parameter.
- Returns:
True if parameter, else False
- Return type:
boolean
- IsRecorded()¶
Returns whether the variable is recorded during execution.
- Returns:
True if recorded, else False
- Return type:
boolean
- IsReturn()¶
Returns whether the variable is a return value.
- Returns:
True if return value, else False
- Return type:
boolean
- SetDescription(description)¶
Sets the description of the variable.
- Parameters:
- description : str¶
Description of variable
-
SetParameter(enable=
True)¶ Sets whether the variable is a parameter or not.
- Parameters:
- enable : boolean¶
Whether the variable is a parameter or not