FloParamsReport

Python pydantic class corresponding to json type `flo.params.report`.

class gwatn.types.FloParamsReport(*, GNodeAlias, GNodeInstanceId, FloParamsTypeName, FloParamsTypeVersion, ReportGeneratedTimeUnixS, IrlTimeUnixS=None, Params, TypeName='flo.params.report', Version='000')

Flo Params Report.

Type used for a message provided by an AtomicTNode or SCADA actor re the flo parameters just used to run a FLO. [More info](https://gridworks-atn.readthedocs.io/en/latest/flo.html#flo-params).

Parameters:

  • GNodeAlias (str) –

  • GNodeInstanceId (str) –

  • FloParamsTypeName (str) –

  • FloParamsTypeVersion (str) –

  • ReportGeneratedTimeUnixS (int) –

  • IrlTimeUnixS (int | None) –

  • Params (FloParams) –

  • TypeName (Literal['flo.params.report']) –

  • Version (str) –

GNodeAlias:

  • Description:

  • Format: LeftRightDot

GNodeInstanceId:

  • Description:

  • Format: UuidCanonicalTextual

FloParamsTypeName:

  • Description:

  • Format: LeftRightDot

FloParamsTypeVersion:

  • Description:

ReportGeneratedTimeUnixS:

  • Description:

  • Format: ReasonableUnixTimeS

IrlTimeUnixS:

  • Description:

  • Format: ReasonableUnixTimeS

Params:

  • Description:

class gwatn.types.flo_params_report.check_is_reasonable_unix_time_s(v)

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

Raises:

ValueError – if not ReasonableUnixTimeS format

Parameters:

v (int) –

class gwatn.types.flo_params_report.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 gwatn.types.flo_params_report.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 gwatn.types.FloParamsReport_Maker(g_node_alias, g_node_instance_id, flo_params_type_name, flo_params_type_version, report_generated_time_unix_s, irl_time_unix_s, params)
Parameters:

  • g_node_alias (str) –

  • g_node_instance_id (str) –

  • flo_params_type_name (str) –

  • flo_params_type_version (str) –

  • report_generated_time_unix_s (int) –

  • irl_time_unix_s (int | None) –

  • params (FloParams) –

classmethod tuple_to_type(tuple)

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

Parameters:

tuple (FloParamsReport) –

Return type:

str

classmethod type_to_tuple(t)

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

Parameters:

t (str) –

Return type:

FloParamsReport