FloParams

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

class gwatn.types.FloParams(*, GNodeAlias, FloParamsUid, HomeCity='MILLINOCKET_ME', TimezoneString='US/Eastern', StartYearUtc=2020, StartMonthUtc=1, StartDayUtc=1, StartHourUtc=0, StartMinuteUtc=0, TypeName='flo.params', Version='000', **extra_data)

Base class for Forward Looking Optimizer params.

Derived classes are expected to have TypeNames enforced as literals that start with flo.params. E.g. flo.params.brickstorageheater. This container is used for sending messages that include flo.params (i.e, flo.params.report [More info](https://gridworks-atn.readthedocs.io/en/latest/flo.html#flo-params).

Parameters:

  • GNodeAlias (str) –

  • FloParamsUid (str) –

  • HomeCity (str) –

  • TimezoneString (str) –

  • StartYearUtc (int) –

  • StartMonthUtc (int) –

  • StartDayUtc (int) –

  • StartHourUtc (int) –

  • StartMinuteUtc (int) –

  • TypeName (str) –

  • Version (str) –

  • extra_data (Any) –

GNodeAlias:

  • Description:

  • Format: LeftRightDot

FloParamsUid:

  • Description:

  • Format: UuidCanonicalTextual

HomeCity:

  • Description:

TimezoneString:

  • Description:

StartYearUtc:

  • Description:

StartMonthUtc:

  • Description:

StartDayUtc:

  • Description:

StartHourUtc:

  • Description:

StartMinuteUtc:

  • Description:

class gwatn.types.flo_params.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.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.FloParams_Maker(g_node_alias, flo_params_uid, home_city, timezone_string, start_year_utc, start_month_utc, start_day_utc, start_hour_utc, start_minute_utc)
Parameters:

  • g_node_alias (str) –

  • flo_params_uid (str) –

  • home_city (str) –

  • timezone_string (str) –

  • start_year_utc (int) –

  • start_month_utc (int) –

  • start_day_utc (int) –

  • start_hour_utc (int) –

  • start_minute_utc (int) –

classmethod tuple_to_type(tuple)

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

Parameters:

tuple (FloParams) –

Return type:

str

classmethod type_to_tuple(t)

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

Parameters:

t (str) –

Return type:

FloParams