Class: ExcitationSystemUserDefined

name: ExcitationSystemUserDefined
description: Excitation system 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: ExcitationSystemDynamics
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:ExcitationSystemUserDefined.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:ExcitationSystemUserDefined.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:ExcitationSystemUserDefined

name: ExcitationSystemUserDefined
description: Excitation system 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: ExcitationSystemDynamics
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:ExcitationSystemUserDefined.proprietary
    multivalued: false
    alias: proprietary
    owner: ExcitationSystemUserDefined
    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:ExcitationSystemUserDefined.ProprietaryParameterDynamics
    multivalued: true
    alias: proprietary_parameter_dynamics
    owner: ExcitationSystemUserDefined
    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
  synchronous_machine_dynamics:
    name: synchronous_machine_dynamics
    description: Synchronous machine model with which this excitation system model
      is associated.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ExcitationSystemDynamics.SynchronousMachineDynamics
    multivalued: false
    alias: synchronous_machine_dynamics
    owner: ExcitationSystemUserDefined
    domain_of:
    - SynchronousMachine
    - GenICompensationForGenJ
    - ExcitationSystemDynamics
    - TurbineGovernorDynamics
    - MechanicalLoadDynamics
    range: SynchronousMachineDynamics
    required: true
  power_system_stabilizer_dynamics:
    name: power_system_stabilizer_dynamics
    description: Power system stabilizer model associated with this excitation system
      model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ExcitationSystemDynamics.PowerSystemStabilizerDynamics
    multivalued: false
    alias: power_system_stabilizer_dynamics
    owner: ExcitationSystemUserDefined
    domain_of:
    - ExcitationSystemDynamics
    - RemoteInputSignal
    range: PowerSystemStabilizerDynamics
    required: false
  pfvar_controller_type_dynamics:
    name: pfvar_controller_type_dynamics
    description: Power factor or VAr controller type 2 model associated with this
      excitation system model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ExcitationSystemDynamics.PFVArControllerType2Dynamics
    multivalued: false
    alias: pfvar_controller_type_dynamics
    owner: ExcitationSystemUserDefined
    domain_of:
    - ExcitationSystemDynamics
    - RemoteInputSignal
    - VoltageAdjusterDynamics
    range: PFVArControllerType2Dynamics
    required: false
  overexcitation_limiter_dynamics:
    name: overexcitation_limiter_dynamics
    description: Overexcitation limiter model associated with this excitation system
      model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ExcitationSystemDynamics.OverexcitationLimiterDynamics
    multivalued: false
    alias: overexcitation_limiter_dynamics
    owner: ExcitationSystemUserDefined
    domain_of:
    - ExcitationSystemDynamics
    range: OverexcitationLimiterDynamics
    required: false
  discontinuous_excitation_control_dynamics:
    name: discontinuous_excitation_control_dynamics
    description: Discontinuous excitation control model associated with this excitation
      system model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ExcitationSystemDynamics.DiscontinuousExcitationControlDynamics
    multivalued: false
    alias: discontinuous_excitation_control_dynamics
    owner: ExcitationSystemUserDefined
    domain_of:
    - ExcitationSystemDynamics
    - RemoteInputSignal
    range: DiscontinuousExcitationControlDynamics
    required: false
  underexcitation_limiter_dynamics:
    name: underexcitation_limiter_dynamics
    description: Undrexcitation limiter model associated with this excitation system
      model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ExcitationSystemDynamics.UnderexcitationLimiterDynamics
    multivalued: false
    alias: underexcitation_limiter_dynamics
    owner: ExcitationSystemUserDefined
    domain_of:
    - ExcitationSystemDynamics
    - RemoteInputSignal
    range: UnderexcitationLimiterDynamics
    required: false
  voltage_compensator_dynamics:
    name: voltage_compensator_dynamics
    description: Voltage compensator model associated with this excitation system
      model.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ExcitationSystemDynamics.VoltageCompensatorDynamics
    multivalued: false
    alias: voltage_compensator_dynamics
    owner: ExcitationSystemUserDefined
    domain_of:
    - ExcitationSystemDynamics
    - RemoteInputSignal
    range: VoltageCompensatorDynamics
    required: true
  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: ExcitationSystemUserDefined
    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: ExcitationSystemUserDefined
    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: ExcitationSystemUserDefined
    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: ExcitationSystemUserDefined
    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: ExcitationSystemUserDefined
    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: ExcitationSystemUserDefined
    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: ExcitationSystemUserDefined
    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: ExcitationSystemUserDefined
    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: ExcitationSystemUserDefined
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:ExcitationSystemUserDefined