Reset Node

class eagerx.core.specs.ResetNodeSpec(params)[source]

A parameter specification that specifies how BaseEnv should initialize the node.

property config: eagerx.core.view.SpecView

Provides an API to set/get the parameters to initialize.

The default parameters are:

  • Spec.config.name: str

    User specified unique node name.

  • Spec.config.rate: float

    Rate (Hz) at which the callback() is called.

  • Spec.config.process: int = 0

    Process in which the node is launched. See process for all options.

  • Spec.config.color: str = grey

    Specifies the color of logged messages & node color in the GUI. Check-out the termcolor documentation for the supported colors.

  • Spec.config.print_mode: int = 1

    Specifies the different modes for printing: {1: TERMCOLOR, 2: ROS}.

  • Spec.config.log_level: int = 30

    Specifies the log level for the engine: {0: SILENT, 10: DEBUG, 20: INFO, 30: WARN, 40: ERROR, 50: FATAL}

Return type

SpecView

Returns

API to get/set parameters.

property feedthroughs: eagerx.core.view.SpecView

Provides an API to set/get the parameters of a feedthrough corresponding to registered eagerx.core.register.outputs().

The mutable parameters are:

  • Spec.feedthroughs.<name>.processor: ProcessorSpec = None

    A processor that preprocesses the received input message before passing it to the node’s callback().

  • Spec.feedthroughs.<name>.space: dict = None

    This space defines the format of valid messages.

  • Spec.feedthroughs.<name>.delay: float = 0.0

    A non-negative simulated delay (seconds). This delay is ignored if simulate_delays = True in the engine’s spec().

Return type

SpecView

Returns

API to get/set parameters.

property inputs: eagerx.core.view.SpecView

Provides an API to set/get the parameters of registered eagerx.core.register.inputs().

The mutable parameters are:

  • Spec.inputs.<name>.window: int = 1

    A non-negative number that specifies the number of messages to pass to the node’s callback().

    • window = 1: Only the last received input message.

    • window = x > 1: The trailing last x received input messages.

    • window = 0: All input messages received since the last call to the node’s callback().

    Note

    With window = 0, the number of input messages may vary and can even be zero.

  • Spec.inputs.<name>.processor: ProcessorSpec = None

    A processor that preprocesses the received input message before passing it to the node’s callback().

  • Spec.inputs.<name>.space: dict = None

    This space defines the format of valid messages.

  • Spec.inputs.<name>.delay: float = 0.0

    A non-negative simulated delay (seconds). This delay is ignored if simulate_delays = True in the engine’s spec().

  • Spec.inputs.<name>.skip: bool = False

    Skip the dependency on this input during the first call to the node’s callback(). May be necessary to ensure that the connected graph is directed and acyclic.

Return type

SpecView

Returns

API to get/set parameters.

property outputs: eagerx.core.view.SpecView

Provides an API to set/get the parameters of registered eagerx.core.register.outputs().

The mutable parameters are:

  • Spec.outputs.<name>.processor: ProcessorSpec = None

    A processor that preprocesses the output message, returned by callback(), before publishing it.

  • Spec.outputs.<name>.space: dict = None

    This space defines the format of valid messages.

Return type

SpecView

Returns

API to get/set parameters.

property states: eagerx.core.view.SpecView

Provides an API to set/get the parameters of registered eagerx.core.register.states().

The mutable parameters are:

  • Spec.states.<name>.space: dict = None

    This space defines the format of valid messages.

Return type

SpecView

Returns

API to get/set parameters.

property targets: eagerx.core.view.SpecView

Provides an API to set/get the parameters of registered eagerx.core.register.targets().

The mutable parameters are:

  • Spec.targets.<name>.processor: ProcessorSpec = None

    A processor that preprocesses the received state message before passing it to the node’s callback().

Return type

SpecView

Returns

API to get/set parameters.