Ready

Python class corresponding to the GridWorks type ready.001 (VersionedTypeName).

class gridworks.types.Ready(*, FromGNodeAlias, FromGNodeInstanceId, TimeUnixS, TypeName='ready', Version='001')

Used in simulations by TimeCoordinator GNodes.

Only intended for simulations that do not have sub-second TimeSteps. TimeCoordinators based on `gridworks-timecoordinator` have a notion of actors whose Ready must be received before issuing the next TimeStep. [More info](https://gridworks.readthedocs.io/en/latest/time-coordinator.html).

Parameters:

  • FromGNodeAlias (str) –

  • FromGNodeInstanceId (str) –

  • TimeUnixS (int) –

  • TypeName (Literal['ready']) –

  • Version (str) –

FromGNodeAlias:

  • Description: The GNodeAlias of the sender

  • Format: LeftRightDot

FromGNodeInstanceId:

  • Description: The GNodeInstanceId of the sender

  • Format: UuidCanonicalTextual

TimeUnixS:

  • Description: Latest simulated time for sender. The time in unix seconds of the latest TimeStep received from the TimeCoordinator by the actor that sent the payload.

class gridworks.types.ready.check_is_uuid_canonical_textual(v)

UuidCanonicalTextual format: A string of hex words separated by hyphens of length 8-4-4-4-12.

Raises:

ValueError – if not UuidCanonicalTextual format

Parameters:

v (str) –

class gridworks.types.ready.check_is_left_right_dot(v)

LeftRightDot format: Lowercase alphanumeric words separated by periods, most significant word (on the left) starting with an alphabet character.

Raises:

ValueError – if not LeftRightDot format

Parameters:

v (str) –

class gridworks.types.Ready_Maker(from_g_node_alias, from_g_node_instance_id, time_unix_s)
Parameters:

  • from_g_node_alias (str) –

  • from_g_node_instance_id (str) –

  • time_unix_s (int) –

classmethod tuple_to_type(tuple)

Given a Python class object, returns the serialized JSON type object

Parameters:

tuple (Ready) –

Return type:

str

classmethod type_to_tuple(t)

Given a serialized JSON type object, returns the Python class object

Parameters:

t (str) –

Return type:

Ready