Message

class eagerx.utils.utils.Msg(info: eagerx.utils.utils.Info, msgs: List[Any])[source]

A dataclass representing a (windowed) input that is passed to callback().

info: eagerx.utils.utils.Info: Info on the received messages in msgs.

msgs: List[Any]: The received messages with indexing msgs[-1] being the most recent message and msgs[0] the oldest.

class eagerx.utils.utils.Info(name: Optional[str] = None, node_tick: Optional[int] = None, rate_in: Optional[float] = None, t_node: Optional[List[eagerx.utils.utils.Stamp]] = None, t_in: Optional[List[eagerx.utils.utils.Stamp]] = None, done: Optional[bool] = None)[source]

A dataclass containing info about the received messages in msgs.

name: str: Name of the registered input.

node_tick: int: Number of times callback() has been called since the last reset.

rate_in: float: Rate (Hz) of the input.

t_in: List[eagerx.utils.utils.Stamp]: Simulated timestamp that states at what time the message was received according to rate_in and seq.

t_node: List[eagerx.utils.utils.Stamp]: Simulated timestamp that states during which cycle the message was received since the last reset according to rate and node_tick.

class eagerx.utils.utils.Stamp(seq: Optional[int] = None, sc: Optional[float] = None, wc: Optional[float] = None)[source]

A dataclass for timestamping received messages.

sc: float: Timestamp according to the simulated clock (seconds). This time is scaled by the real-time factor if > 0.

seq: int: Sequence number of received message.

wc: float: Timestamp according to the wall clock (seconds).