GtShCliAtnCmd

Python pydantic class corresponding to json type gt.sh.cli.atn.cmd, version 110.

class gwproto.types.GtShCliAtnCmd(*, FromGNodeAlias, SendSnapshot, FromGNodeId, TypeName='gt.sh.cli.atn.cmd', Version='110')

AtomicTNode CLI Command.

This is a generic type mechanism for a crude command line interface on a SCADA, brokered by the AtomicTNode.

Parameters:

  • FromGNodeAlias (str)

  • SendSnapshot (bool)

  • FromGNodeId (str)

  • TypeName (Literal['gt.sh.cli.atn.cmd'])

  • Version (Literal['110'])

as_dict()

Translate the object into a dictionary representation that can be serialized into a gt.sh.cli.atn.cmd.110 object.

This method prepares the object for serialization by the as_type method, creating a dictionary with key-value pairs that follow the requirements for an instance of the gt.sh.cli.atn.cmd.110 type. Unlike the standard python dict method, it makes the following substantive changes: - Enum Values: Translates between the values used locally by the actor to the symbol sent in messages. - Removes any key-value pairs where the value is None for a clearer message, especially in cases with many optional attributes.

It also applies these changes recursively to sub-types.

Return type:

Dict[str, Any]

as_type()

Serialize to the gt.sh.cli.atn.cmd.110 representation.

Instances in the class are python-native representations of gt.sh.cli.atn.cmd.110 objects, while the actual gt.sh.cli.atn.cmd.110 object is the serialized UTF-8 byte string designed for sending in a message.

This method calls the as_dict() method, which differs from the native python dict() in the following key ways: - Enum Values: Translates between the values used locally by the actor to the symbol sent in messages. - - Removes any key-value pairs where the value is None for a clearer message, especially in cases with many optional attributes.

It also applies these changes recursively to sub-types.

Its near-inverse is GtShCliAtnCmd.type_to_tuple(). If the type (or any sub-types) includes an enum, then the type_to_tuple will map an unrecognized symbol to the default enum value. This is why these two methods are only ‘near’ inverses.

Return type:

bytes

FromGNodeAlias:

  • Description: GNodeAlias. Must be the SCADA’s AtomicTNode.

  • Format: LeftRightDot

SendSnapshot:

  • Description: Send Snapshot. Asks SCADA to send back a snapshot. For this version of the type, nothing would happen if SendSnapshot were set to False. However, we include this in case additional variations are added later.

FromGNodeId:

  • Description: GNodeId.

  • Format: UuidCanonicalTextual

TypeName:

  • Description: All GridWorks Versioned Types have a fixed TypeName, which is a string of lowercase alphanumeric words separated by periods, most significant word (on the left) starting with an alphabet character, and final word NOT all Hindu-Arabic numerals.

Version:

  • Description: All GridWorks Versioned Types have a fixed version, which is a string of three Hindu-Arabic numerals.

class gwproto.types.gt_sh_cli_atn_cmd.check_is_uuid_canonical_textual(v)

Checks UuidCanonicalTextual format

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

Parameters:

v (str) – the candidate

Raises:

ValueError – if v is not UuidCanonicalTextual format

class gwproto.types.gt_sh_cli_atn_cmd.check_is_left_right_dot(v)

Checks LeftRightDot Format

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

Parameters:

v (str) – the candidate

Raises:

ValueError – if v is not LeftRightDot format

class gwproto.types.GtShCliAtnCmd_Maker(from_g_node_alias, send_snapshot, from_g_node_id)
Parameters:

  • from_g_node_alias (str)

  • send_snapshot (bool)

  • from_g_node_id (str)

classmethod dict_to_tuple(d)

Deserialize a dictionary representation of a gt.sh.cli.atn.cmd.110 message object into a GtShCliAtnCmd python object for internal use.

This is the near-inverse of the GtShCliAtnCmd.as_dict() method:

  • Enums: translates between the symbols sent in messages between actors and

the values used by the actors internally once they’ve deserialized the messages.

  • Types: recursively validates and deserializes sub-types.

Note that if a required attribute with a default value is missing in a dict, this method will raise a SchemaError. This differs from the pydantic BaseModel practice of auto-completing missing attributes with default values when they exist.

Parameters:

d (dict) – the dictionary resulting from json.loads(t) for a serialized JSON type object t.

Raises:

SchemaError – if the dict cannot be turned into a GtShCliAtnCmd object.

Returns:

GtShCliAtnCmd

Return type:

GtShCliAtnCmd

classmethod tuple_to_type(tpl)

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

Parameters:

tpl (GtShCliAtnCmd)

Return type:

bytes

classmethod type_to_tuple(t)

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

Parameters:

t (bytes)

Return type:

GtShCliAtnCmd