Skip to content

Class: MechanicalLoadUserDefined

Mechanical load function block whose dynamic behaviour is described by a user-defined model.

URI: cim:MechanicalLoadUserDefined

 classDiagram
    class MechanicalLoadUserDefined
      MechanicalLoadDynamics <|-- MechanicalLoadUserDefined

      MechanicalLoadUserDefined : alias_name

      MechanicalLoadUserDefined : asynchronous_machine_dynamics

          MechanicalLoadUserDefined --> AsynchronousMachineDynamics : asynchronous_machine_dynamics

      MechanicalLoadUserDefined : description

      MechanicalLoadUserDefined : diagram_objects

          MechanicalLoadUserDefined --> DiagramObject : diagram_objects

      MechanicalLoadUserDefined : enabled

      MechanicalLoadUserDefined : instance_set

          MechanicalLoadUserDefined --> InstanceSet : instance_set

      MechanicalLoadUserDefined : m_rid

      MechanicalLoadUserDefined : names

          MechanicalLoadUserDefined --> Name : names

      MechanicalLoadUserDefined : properties_cimdata_object

          MechanicalLoadUserDefined --> ChangeSetMember : properties_cimdata_object

      MechanicalLoadUserDefined : proprietary

      MechanicalLoadUserDefined : proprietary_parameter_dynamics

          MechanicalLoadUserDefined --> ProprietaryParameterDynamics : proprietary_parameter_dynamics

      MechanicalLoadUserDefined : synchronous_machine_dynamics

          MechanicalLoadUserDefined --> SynchronousMachineDynamics : synchronous_machine_dynamics

      MechanicalLoadUserDefined : targeting_cimdata_object

          MechanicalLoadUserDefined --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
proprietary 0..1
Boolean		 Behaviour is based on a proprietary model as opposed to a detailed model direct
proprietary_parameter_dynamics 0..*
ProprietaryParameterDynamics		 Parameter of this proprietary user-defined model direct
asynchronous_machine_dynamics 0..1
AsynchronousMachineDynamics		 Asynchronous machine model with which this mechanical load model is associate... MechanicalLoadDynamics
synchronous_machine_dynamics 0..1
SynchronousMachineDynamics		 Synchronous machine model with which this mechanical load model is associated MechanicalLoadDynamics
enabled 0..1
Boolean		 Function block used indicator DynamicsFunctionBlock
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

Usages

used by used in type used
ProprietaryParameterDynamics mechanical_load_user_defined range MechanicalLoadUserDefined

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: MechanicalLoadUserDefined
description: Mechanical load function block whose dynamic behaviour is described by
  <font color="#0f0f0f">a user-defined model.</font>
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: MechanicalLoadDynamics
attributes:
  proprietary:
    name: proprietary
    description: "Behaviour is based on a proprietary model as opposed to a detailed\
      \ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
      \ understood by sending and receiving applications and parameters passed as\
      \ general attributes\r\nfalse = user-defined model is explicitly defined in\
      \ terms of control blocks and their input and output signals."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MechanicalLoadUserDefined.proprietary
    multivalued: false
    domain_of:
    - SynchronousMachineUserDefined
    - SVCUserDefined
    - VSCUserDefined
    - CSCUserDefined
    - WindPlantUserDefined
    - WindType3or4UserDefined
    - WindType1or2UserDefined
    - LoadUserDefined
    - VoltageCompensatorUserDefined
    - PFVArControllerType2UserDefined
    - VoltageAdjusterUserDefined
    - PFVArControllerType1UserDefined
    - DiscontinuousExcitationControlUserDefined
    - PowerSystemStabilizerUserDefined
    - UnderexcitationLimiterUserDefined
    - OverexcitationLimiterUserDefined
    - ExcitationSystemUserDefined
    - MechanicalLoadUserDefined
    - TurbineLoadControllerUserDefined
    - TurbineGovernorUserDefined
    - AsynchronousMachineUserDefined
    range: boolean
    required: false
  proprietary_parameter_dynamics:
    name: proprietary_parameter_dynamics
    description: Parameter of this proprietary user-defined model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MechanicalLoadUserDefined.ProprietaryParameterDynamics
    multivalued: true
    domain_of:
    - SynchronousMachineUserDefined
    - SVCUserDefined
    - VSCUserDefined
    - CSCUserDefined
    - WindPlantUserDefined
    - WindType3or4UserDefined
    - WindType1or2UserDefined
    - LoadUserDefined
    - VoltageCompensatorUserDefined
    - PFVArControllerType2UserDefined
    - VoltageAdjusterUserDefined
    - PFVArControllerType1UserDefined
    - DiscontinuousExcitationControlUserDefined
    - PowerSystemStabilizerUserDefined
    - UnderexcitationLimiterUserDefined
    - OverexcitationLimiterUserDefined
    - ExcitationSystemUserDefined
    - MechanicalLoadUserDefined
    - TurbineLoadControllerUserDefined
    - TurbineGovernorUserDefined
    - AsynchronousMachineUserDefined
    range: ProprietaryParameterDynamics
    required: false
class_uri: cim:MechanicalLoadUserDefined

Induced

name: MechanicalLoadUserDefined
description: Mechanical load function block whose dynamic behaviour is described by
  <font color="#0f0f0f">a user-defined model.</font>
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: MechanicalLoadDynamics
attributes:
  proprietary:
    name: proprietary
    description: "Behaviour is based on a proprietary model as opposed to a detailed\
      \ model.\r\ntrue = user-defined model is proprietary with behaviour mutually\
      \ understood by sending and receiving applications and parameters passed as\
      \ general attributes\r\nfalse = user-defined model is explicitly defined in\
      \ terms of control blocks and their input and output signals."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MechanicalLoadUserDefined.proprietary
    multivalued: false
    alias: proprietary
    owner: MechanicalLoadUserDefined
    domain_of:
    - SynchronousMachineUserDefined
    - SVCUserDefined
    - VSCUserDefined
    - CSCUserDefined
    - WindPlantUserDefined
    - WindType3or4UserDefined
    - WindType1or2UserDefined
    - LoadUserDefined
    - VoltageCompensatorUserDefined
    - PFVArControllerType2UserDefined
    - VoltageAdjusterUserDefined
    - PFVArControllerType1UserDefined
    - DiscontinuousExcitationControlUserDefined
    - PowerSystemStabilizerUserDefined
    - UnderexcitationLimiterUserDefined
    - OverexcitationLimiterUserDefined
    - ExcitationSystemUserDefined
    - MechanicalLoadUserDefined
    - TurbineLoadControllerUserDefined
    - TurbineGovernorUserDefined
    - AsynchronousMachineUserDefined
    range: boolean
    required: false
  proprietary_parameter_dynamics:
    name: proprietary_parameter_dynamics
    description: Parameter of this proprietary user-defined model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MechanicalLoadUserDefined.ProprietaryParameterDynamics
    multivalued: true
    alias: proprietary_parameter_dynamics
    owner: MechanicalLoadUserDefined
    domain_of:
    - SynchronousMachineUserDefined
    - SVCUserDefined
    - VSCUserDefined
    - CSCUserDefined
    - WindPlantUserDefined
    - WindType3or4UserDefined
    - WindType1or2UserDefined
    - LoadUserDefined
    - VoltageCompensatorUserDefined
    - PFVArControllerType2UserDefined
    - VoltageAdjusterUserDefined
    - PFVArControllerType1UserDefined
    - DiscontinuousExcitationControlUserDefined
    - PowerSystemStabilizerUserDefined
    - UnderexcitationLimiterUserDefined
    - OverexcitationLimiterUserDefined
    - ExcitationSystemUserDefined
    - MechanicalLoadUserDefined
    - TurbineLoadControllerUserDefined
    - TurbineGovernorUserDefined
    - AsynchronousMachineUserDefined
    range: ProprietaryParameterDynamics
    required: false
  asynchronous_machine_dynamics:
    name: asynchronous_machine_dynamics
    description: Asynchronous machine model with which this mechanical load model
      is associated. MechanicalLoadDynamics shall have either an association to SynchronousMachineDynamics
      or to AsynchronousMachineDynamics.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MechanicalLoadDynamics.AsynchronousMachineDynamics
    multivalued: false
    alias: asynchronous_machine_dynamics
    owner: MechanicalLoadUserDefined
    domain_of:
    - WindTurbineType1or2Dynamics
    - TurbineGovernorDynamics
    - MechanicalLoadDynamics
    - AsynchronousMachine
    range: AsynchronousMachineDynamics
    required: false
  synchronous_machine_dynamics:
    name: synchronous_machine_dynamics
    description: Synchronous machine model with which this mechanical load model is
      associated. MechanicalLoadDynamics shall have either an association to SynchronousMachineDynamics
      or AsynchronousMachineDyanmics.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:MechanicalLoadDynamics.SynchronousMachineDynamics
    multivalued: false
    alias: synchronous_machine_dynamics
    owner: MechanicalLoadUserDefined
    domain_of:
    - SynchronousMachine
    - GenICompensationForGenJ
    - ExcitationSystemDynamics
    - TurbineGovernorDynamics
    - MechanicalLoadDynamics
    range: SynchronousMachineDynamics
    required: false
  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: MechanicalLoadUserDefined
    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: MechanicalLoadUserDefined
    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: MechanicalLoadUserDefined
    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: MechanicalLoadUserDefined
    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: MechanicalLoadUserDefined
    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: MechanicalLoadUserDefined
    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: MechanicalLoadUserDefined
    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: MechanicalLoadUserDefined
    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: MechanicalLoadUserDefined
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:MechanicalLoadUserDefined