TaDataChannels

Python pydantic class corresponding to json type ta.data.channels, version 000.

class gwproto.types.TaDataChannels(*, TerminalAssetGNodeAlias, TerminalAssetGNodeId, TimeUnixS, Author, Channels, Identifier, TypeName='ta.data.channels', Version='000')

Terminal Asset Data Channels.

A list of data channels associated to a specific Terminal Asset.

Parameters:

  • TerminalAssetGNodeAlias (str)

  • TerminalAssetGNodeId (str)

  • TimeUnixS (int)

  • Author (str)

  • Channels (List[DataChannel])

  • Identifier (str)

  • TypeName (Literal['ta.data.channels'])

  • Version (Literal['000'])

as_dict()

Translate the object into a dictionary representation that can be serialized into a ta.data.channels.000 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 ta.data.channels.000 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 ta.data.channels.000 representation.

Instances in the class are python-native representations of ta.data.channels.000 objects, while the actual ta.data.channels.000 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 TaDataChannels.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

TerminalAssetGNodeAlias:

  • Description: GNodeAlias for the Terminal Asset. The Alias of the Terminal Asset about which the time series data is providing information.

  • Format: LeftRightDot

TerminalAssetGNodeId:

  • Description: GNodeId for the Terminal Asset. The immutable unique identifier for the Terminal Asset.

  • Format: UuidCanonicalTextual

TimeUnixS:

  • Description: TimeUnixS. The time that this list of data channels was created

  • Format: ReasonableUnixTimeS

Author:

  • Description: Author of this list of data channels.

Channels:

  • Description: The list of data channels.

Identifier:

  • Description: Identifier. Unique identifier for a specific instance of this type that can be used to establish how time series csv’s were constructed.

  • 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.ta_data_channels.check_is_reasonable_unix_time_s(v)

Checks ReasonableUnixTimeS format

ReasonableUnixTimeS format: unix seconds between Jan 1 2000 and Jan 1 3000

Parameters:

v (int) – the candidate

Raises:

ValueError – if v is not ReasonableUnixTimeS format

class gwproto.types.ta_data_channels.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.ta_data_channels.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.TaDataChannels_Maker(terminal_asset_g_node_alias, terminal_asset_g_node_id, time_unix_s, author, channels, identifier)
Parameters:

  • terminal_asset_g_node_alias (str)

  • terminal_asset_g_node_id (str)

  • time_unix_s (int)

  • author (str)

  • channels (List[DataChannel])

  • identifier (str)

classmethod dict_to_tuple(d)

Deserialize a dictionary representation of a ta.data.channels.000 message object into a TaDataChannels python object for internal use.

This is the near-inverse of the TaDataChannels.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 TaDataChannels object.

Returns:

TaDataChannels

Return type:

TaDataChannels

classmethod tuple_to_type(tpl)

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

Parameters:

tpl (TaDataChannels)

Return type:

bytes

classmethod type_to_tuple(t)

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

Parameters:

t (bytes)

Return type:

TaDataChannels