This section contains a reference for the API that is accessible via the script component.
| Method | Description |
|---|---|
def RCE.close_all_outputs ( )
| Closes all outputs that are known in RCE. |
def RCE.close_output ( name )
| Closes the RCE output with the given name |
def RCE.fail ( reason ) | Fails the RCE component with the given reason |
def RCE.get_execution_count ( )
| Returns the current execution count of the RCE component |
def RCE.get_input_names_with_datum ( )
| Returns all input names that have got a data value from RCE. |
def RCE.get_output_names ( ) | Returns the read names of all outputs from RCE |
def RCE.get_state_dict ( ) | Returns the current state dictionary |
def RCE.getallinputs ( ) | Gets a dictionary with all inputs from RCE |
def RCE.read_input ( name ) | Gets the value for the given input name or an error, if the input is not there (e.g. not required and it got no value) |
def RCE.read_input ( name , defaultvalue ) | Gets the value for the given input name or returns the default value if there is no input connected and the input not required |
def RCE.read_state_variable ( name ) | Reads the given state variables value, if it exists, else None is returned |
def RCE.read_state_variable ( name, defaultvalue
) | Reads the given state variables value, if it exists, else a the default value is returned and stored in the dictionary |
def RCE.write_not_a_value_output ( name ) | Sets the given output to "not a value" data type |
def RCE.write_output ( name, value ) | Sets the given value to the output "name" which will be read from RCE |
def RCE.write_state_variable ( name, value ) | Writes a variable name in the dictionary for the components state |