Skip to content

Class: DynamicsFunctionBlock

Abstract parent class for all Dynamics function blocks.

URI: cim:DynamicsFunctionBlock

 classDiagram
    class DynamicsFunctionBlock
      IdentifiedObject <|-- DynamicsFunctionBlock


      DynamicsFunctionBlock <|-- RotatingMachineDynamics
      DynamicsFunctionBlock <|-- VoltageCompensatorDynamics
      DynamicsFunctionBlock <|-- ExcitationSystemDynamics
      DynamicsFunctionBlock <|-- PowerSystemStabilizerDynamics
      DynamicsFunctionBlock <|-- WindPlantDynamics
      DynamicsFunctionBlock <|-- WindTurbineType3or4Dynamics
      DynamicsFunctionBlock <|-- UnderexcitationLimiterDynamics
      DynamicsFunctionBlock <|-- DiscontinuousExcitationControlDynamics
      DynamicsFunctionBlock <|-- WindTurbineType1or2Dynamics
      DynamicsFunctionBlock <|-- TurbineGovernorDynamics
      DynamicsFunctionBlock <|-- TurbineLoadControllerDynamics
      DynamicsFunctionBlock <|-- MechanicalLoadDynamics
      DynamicsFunctionBlock <|-- PFVArControllerType1Dynamics
      DynamicsFunctionBlock <|-- VoltageAdjusterDynamics
      DynamicsFunctionBlock <|-- OverexcitationLimiterDynamics
      DynamicsFunctionBlock <|-- PFVArControllerType2Dynamics
      DynamicsFunctionBlock <|-- CrossCompoundTurbineGovernorDynamics
      DynamicsFunctionBlock <|-- StaticVarCompensatorDynamics
      DynamicsFunctionBlock <|-- HVDCDynamics


      DynamicsFunctionBlock : alias_name

      DynamicsFunctionBlock : description

      DynamicsFunctionBlock : diagram_objects

          DynamicsFunctionBlock --> DiagramObject : diagram_objects

      DynamicsFunctionBlock : enabled

      DynamicsFunctionBlock : instance_set

          DynamicsFunctionBlock --> InstanceSet : instance_set

      DynamicsFunctionBlock : m_rid

      DynamicsFunctionBlock : names

          DynamicsFunctionBlock --> Name : names

      DynamicsFunctionBlock : properties_cimdata_object

          DynamicsFunctionBlock --> ChangeSetMember : properties_cimdata_object

      DynamicsFunctionBlock : targeting_cimdata_object

          DynamicsFunctionBlock --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
enabled 0..1
Boolean		 Function block used indicator direct
alias_name 0..1
String		 The aliasName is free text human readable name of the object alternative to I... IdentifiedObject
description 0..1
String		 The description is a free human readable text describing or naming the object IdentifiedObject
m_rid 0..1
String		 Master resource identifier issued by a model authority IdentifiedObject
diagram_objects 0..*
DiagramObject		 The diagram objects that are associated with the domain object IdentifiedObject
instance_set 1..1
InstanceSet		 Dataset containing the data objects IdentifiedObject
names 0..*
Name		 All names of this identified object IdentifiedObject
properties_cimdata_object 0..1
ChangeSetMember		 The single CIM data object in the appropriate dataset context IdentifiedObject
targeting_cimdata_object 0..*
ChangeSetMember		 Data objects registered IdentifiedObject

Identifier and Mapping Information

Schema Source

  • from schema: https://cim.ucaiug.io/ns#TC57CIM

Mappings

Mapping Type Mapped Value
self cim:DynamicsFunctionBlock
native cim:DynamicsFunctionBlock

LinkML Source

Direct

name: DynamicsFunctionBlock
description: Abstract parent class for all Dynamics function blocks.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  enabled:
    name: enabled
    description: "Function block used indicator.\r\ntrue = use of function block is\
      \ enabled\r\nfalse = use of function block is disabled."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DynamicsFunctionBlock.enabled
    multivalued: false
    domain_of:
    - ProtectiveAction
    - EndDeviceFunction
    - RegulatingControl
    - DynamicsFunctionBlock
    range: boolean
    required: false
class_uri: cim:DynamicsFunctionBlock

Induced

name: DynamicsFunctionBlock
description: Abstract parent class for all Dynamics function blocks.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  enabled:
    name: enabled
    description: "Function block used indicator.\r\ntrue = use of function block is\
      \ enabled\r\nfalse = use of function block is disabled."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DynamicsFunctionBlock.enabled
    multivalued: false
    alias: enabled
    owner: DynamicsFunctionBlock
    domain_of:
    - ProtectiveAction
    - EndDeviceFunction
    - RegulatingControl
    - DynamicsFunctionBlock
    range: boolean
    required: false
  alias_name:
    name: alias_name
    description: "The aliasName is free text human readable name of the object alternative\
      \ to IdentifiedObject.name. It may be non unique and may not correlate to a\
      \ naming hierarchy.\r\nThe attribute aliasName is retained because of backwards\
      \ compatibility between CIM relases. It is however recommended to replace aliasName\
      \ with the Name class as aliasName is planned for retirement at a future time.\r\
      \n\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.aliasName
    multivalued: false
    alias: alias_name
    owner: DynamicsFunctionBlock
    domain_of:
    - IdentifiedObject
    range: string
    required: false
  description:
    name: description
    description: The description is a free human readable text describing or naming
      the object. It may be non unique and may not correlate to a naming hierarchy.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.description
    multivalued: false
    alias: description
    owner: DynamicsFunctionBlock
    domain_of:
    - IdentifiedObject
    - NameType
    - NameTypeAuthority
    - DataSet
    - SwitchingStepGroup
    - AreaReserveSpec
    range: string
    required: false
  m_rid:
    name: m_rid
    description: "Master resource identifier issued by a model authority. The mRID\
      \ is unique within an exchange context. Global uniqueness is easily achieved\
      \ by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is\
      \ strongly recommended.\r\nFor CIMXML data files in RDF syntax conforming to\
      \ IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify\
      \ CIM object elements."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.mRID
    multivalued: false
    alias: m_rid
    owner: DynamicsFunctionBlock
    domain_of:
    - IdentifiedObject
    - DataSet
    range: string
    required: false
  diagram_objects:
    name: diagram_objects
    description: The diagram objects that are associated with the domain object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.DiagramObjects
    multivalued: true
    alias: diagram_objects
    owner: DynamicsFunctionBlock
    domain_of:
    - IdentifiedObject
    range: DiagramObject
    required: false
  instance_set:
    name: instance_set
    description: Dataset containing the data objects.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.InstanceSet
    multivalued: false
    alias: instance_set
    owner: DynamicsFunctionBlock
    domain_of:
    - IdentifiedObject
    range: InstanceSet
    required: true
  names:
    name: names
    description: All names of this identified object.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.Names
    multivalued: true
    alias: names
    owner: DynamicsFunctionBlock
    domain_of:
    - IdentifiedObject
    - NameType
    range: Name
    required: false
  properties_cimdata_object:
    name: properties_cimdata_object
    description: The single CIM data object in the appropriate dataset context.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.PropertiesCIMDataObject
    multivalued: false
    alias: properties_cimdata_object
    owner: DynamicsFunctionBlock
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
  targeting_cimdata_object:
    name: targeting_cimdata_object
    description: Data objects registered.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:IdentifiedObject.TargetingCIMDataObject
    multivalued: true
    alias: targeting_cimdata_object
    owner: DynamicsFunctionBlock
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:DynamicsFunctionBlock