Register
- class eagerx.core.register.inputs(**inputs)[source]
A decorator to register the inputs to a
callback()
.The
callback()
method should be decorated.- Parameters:
inputs (
Any
) – The input’s msg_type class.- Return type:
Callable
- class eagerx.core.register.outputs(**outputs)[source]
A decorator to register the outputs of a
callback()
.The
callback()
method should be decorated.- Parameters:
outputs – The output’s msg_type class.
- Return type:
Callable
- class eagerx.core.register.states(**states)[source]
A decorator to register the states for a
reset()
.The
reset()
method should be decorated.- Parameters:
outputs – The state’s msg_type class.
- Return type:
Callable
- class eagerx.core.register.targets(**targets)[source]
A decorator to register the targets of a
callback()
.The
callback()
method should be decorated.- Parameters:
targets – The target’s msg_type class.
- Return type:
Callable
- class eagerx.core.register.sensors(**sensors)[source]
A decorator to register the sensors of an
Object
.The
agnostic()
method should be decorated.- Parameters:
sensors – The sensor’s msg_type class.
- Return type:
Callable
- class eagerx.core.register.actuators(**actuators)[source]
A decorator to register the actuators of an
Object
.The
agnostic()
method should be decorated.- Parameters:
actuators – The actuator’s msg_type class.
- Return type:
Callable
- class eagerx.core.register.engine_states(**engine_states)[source]
A decorator to register the engine states of an
Object
.The
agnostic()
method should be decorated.- Parameters:
engine_states – The engine state’s msg_type class.
- Return type:
Callable
- class eagerx.core.register.engine(engine_cls, entity=None)[source]
A decorator to register an engine implementation of an
Object
.Note
In our running example, the
example_engine()
method would be decorated.