Distribution Limitsets

Distribution Limitsets#

pydantic model gdm.distribution.common.VoltageLimitSet#

Data model for voltage limit set.

Show JSON schema
{
   "title": "VoltageLimitSet",
   "description": "Data model for voltage limit set.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "default": "",
         "description": "Name of the voltage limit set.",
         "title": "Name",
         "type": "string"
      },
      "limit_type": {
         "$ref": "#/$defs/LimitType",
         "description": "Limit type used."
      },
      "value": {
         "default": "0 kilovar",
         "description": "Voltage threshold.",
         "title": "Value",
         "type": "string"
      }
   },
   "$defs": {
      "LimitType": {
         "description": "Operational limit types.",
         "enum": [
            "min",
            "max"
         ],
         "title": "LimitType",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "limit_type",
      "value"
   ]
}

Config:

  • str_strip_whitespace: bool = True

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • use_enum_values: bool = False

  • arbitrary_types_allowed: bool = True

  • populate_by_name: bool = True

Fields:

  • limit_type (gdm.distribution.enums.LimitType)

  • name (str)

  • uuid (uuid.UUID)

  • value (gdm.quantities.PositiveVoltage)

field limit_type: Annotated[LimitType, FieldInfo(annotation=NoneType, required=True, description='Limit type used.')] [Required]#

Limit type used.

field name: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='', description='Name of the voltage limit set.')] = ''#

Name of the voltage limit set.

field value: ')] [Required]#

Voltage threshold.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: ‘0 kilovar’}

pydantic model gdm.distribution.common.ThermalLimitSet#

Data model for voltage limit set.

Show JSON schema
{
   "title": "ThermalLimitSet",
   "description": "Data model for voltage limit set.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "default": "",
         "description": "Name of the thermal limit set.",
         "title": "Name",
         "type": "string"
      },
      "limit_type": {
         "$ref": "#/$defs/LimitType",
         "description": "Limit type used."
      },
      "value": {
         "default": "0 kilovar",
         "description": "Current threshold.",
         "title": "Value",
         "type": "string"
      }
   },
   "$defs": {
      "LimitType": {
         "description": "Operational limit types.",
         "enum": [
            "min",
            "max"
         ],
         "title": "LimitType",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "limit_type",
      "value"
   ]
}

Config:

  • str_strip_whitespace: bool = True

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • use_enum_values: bool = False

  • arbitrary_types_allowed: bool = True

  • populate_by_name: bool = True

Fields:

  • limit_type (gdm.distribution.enums.LimitType)

  • name (str)

  • uuid (uuid.UUID)

  • value (gdm.quantities.PositiveCurrent)

field limit_type: Annotated[LimitType, FieldInfo(annotation=NoneType, required=True, description='Limit type used.')] [Required]#

Limit type used.

field name: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='', description='Name of the thermal limit set.')] = ''#

Name of the thermal limit set.

field value: ')] [Required]#

Current threshold.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: ‘0 kilovar’}

Contents