Switch Controller

Switch Controller#

pydantic model gdm.distribution.controllers.DistributionSwitchController#

Data model for distribution switch controller.

Show JSON schema
{
   "title": "DistributionSwitchController",
   "description": "Data model for distribution switch controller.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "default": "",
         "description": "Name of the switch controller.",
         "title": "Name",
         "type": "string"
      },
      "delay": {
         "default": null,
         "description": "Fixed delay added to the recloser trip time.",
         "title": "Delay",
         "type": "string"
      },
      "normal_state": {
         "description": "Action to open or close the switch after delay time.",
         "enum": [
            "open",
            "close"
         ],
         "title": "Normal State",
         "type": "string"
      },
      "is_locked": {
         "description": "Boolean value representing whether the switch is locked or not.",
         "title": "Is Locked",
         "type": "boolean"
      }
   },
   "additionalProperties": false,
   "required": [
      "delay",
      "normal_state",
      "is_locked"
   ]
}

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:

  • delay (infrasys.quantities.Time)

  • is_locked (bool)

  • name (str)

  • normal_state (Literal['open', 'close'])

  • uuid (uuid.UUID)

field delay: ')] [Required]#

Fixed delay added to the recloser trip time.

Constraints:

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

field is_locked: Annotated[bool, FieldInfo(annotation=NoneType, required=True, description='Boolean value representing whether the switch is locked or not.')] [Required]#

Boolean value representing whether the switch is locked or not.

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

Name of the switch controller.

field normal_state: Annotated[Literal['open', 'close'], FieldInfo(annotation=NoneType, required=True, description='Action to open or close the switch after delay time.')] [Required]#

Action to open or close the switch after delay time.

Contents