libmuscle.profiling module
- class libmuscle.profiling.ProfileEvent(event_type: ProfileEventType, start_time: ProfileTimestamp | None = None, stop_time: ProfileTimestamp | None = None, port: Port | None = None, port_length: int | None = None, slot: int | None = None, message_number: int | None = None, message_size: int | None = None, message_timestamp: float | None = None)[source]
Bases:
object
A profile event as used by MUSCLE3.
This represents a single measurement of the timing of some event that occurred while executing the simulation.
- Parameters:
event_type – Type of event that was measured.
start_time – When the event started (real-world, not simulation time).
stop_time – When the event ended (real-world, not simulation time).
port – Port used for sending or receiving, if applicable.
port_length – Length of that port, if a vector.
slot – Slot that was sent or received on, if applicable.
message_number – Number of message on this port, if applicable. Starts at 0 for the first message sent or received.
message_size – Size of the message involved, if applicable.
message_timestamp – Timestamp sent with the message, if applicable.
- event_type
Type of event that was measured.
- start_time
When the event started (real-world, not simulation time).
- stop_time
When the event ended (real-world, not simulation time).
- port
Port used for sending or receiving, if applicable.
- port_length
Length of that port, if a vector.
- slot
Slot that was sent or received on, if applicable.
- message_number
Number of message on this port, if applicable. Starts at 0 for the first message sent or received.
- message_size
Size of the message involved, if applicable.
- message_timestamp
Timestamp sent with the message, if applicable.