Skip to content

Class: ForbiddenRegion

_Forbbiden region is operating ranges where the units are unable to maintain steady operation without causing equipment damage. The four attributes that define a forbidden region are the low MW, the High MW, the crossing time, and the crossing cost. _

__

URI: cim:ForbiddenRegion

 classDiagram
    class ForbiddenRegion
      IdentifiedObject <|-- ForbiddenRegion

      ForbiddenRegion : alias_name

      ForbiddenRegion : cross_time

      ForbiddenRegion : crossing_cost

      ForbiddenRegion : description

      ForbiddenRegion : diagram_objects

          ForbiddenRegion --> DiagramObject : diagram_objects

      ForbiddenRegion : high_mw

      ForbiddenRegion : instance_set

          ForbiddenRegion --> InstanceSet : instance_set

      ForbiddenRegion : low_mw

      ForbiddenRegion : m_rid

      ForbiddenRegion : names

          ForbiddenRegion --> Name : names

      ForbiddenRegion : properties_cimdata_object

          ForbiddenRegion --> ChangeSetMember : properties_cimdata_object

      ForbiddenRegion : registered_resource

          ForbiddenRegion --> RegisteredResource : registered_resource

      ForbiddenRegion : targeting_cimdata_object

          ForbiddenRegion --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
crossing_cost 0..1
Float		 Cost associated with crossing the forbidden region
direct
cross_time 0..1
Integer		 Time to cross the forbidden region in minutes direct
high_mw 0..1
Float		 High end of the region definition
direct
low_mw 0..1
Float		 Low end of the region definition direct
registered_resource 0..*
RegisteredResource		 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

Usages

used by used in type used
RegisteredResource forbidden_region range ForbiddenRegion
RegisteredGenerator forbidden_region range ForbiddenRegion
RegisteredInterTie forbidden_region range ForbiddenRegion
RegisteredLoad forbidden_region range ForbiddenRegion
CombinedCycleConfiguration forbidden_region range ForbiddenRegion
RegisteredDistributedResource forbidden_region range ForbiddenRegion

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: ForbiddenRegion
description: "Forbbiden region is operating ranges where the units are unable to maintain\
  \ steady operation without causing equipment damage.  The four attributes that define\
  \ a forbidden region are the low MW, the High MW, the crossing time, and the crossing\
  \ cost.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  crossing_cost:
    name: crossing_cost
    description: "Cost associated with crossing the forbidden region\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ForbiddenRegion.crossingCost
    multivalued: false
    domain_of:
    - ForbiddenRegion
    range: float
    required: false
  cross_time:
    name: cross_time
    description: "Time to cross the forbidden region in minutes.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ForbiddenRegion.crossTime
    multivalued: false
    domain_of:
    - ForbiddenRegion
    range: integer
    required: false
  high_mw:
    name: high_mw
    description: "High end of the region definition\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ForbiddenRegion.highMW
    multivalued: false
    domain_of:
    - ForbiddenRegion
    range: float
    required: false
  low_mw:
    name: low_mw
    description: "Low end of the region definition.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ForbiddenRegion.lowMW
    multivalued: false
    domain_of:
    - ForbiddenRegion
    range: float
    required: false
  registered_resource:
    name: registered_resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ForbiddenRegion.RegisteredResource
    multivalued: true
    domain_of:
    - TimeSeries
    - Reason
    - DotInstruction
    - MarketParticipant
    - MPMResourceStatus
    - MPMTestThreshold
    - SubControlArea
    - AdjacentCASet
    - HostControlArea
    - RampRateCurve
    - SchedulingPoint
    - ResourceVerifiableCosts
    - ContractDistributionFactor
    - SubstitutionResourceList
    - MktConnectivityNode
    - AggregateNode
    - Instructions
    - ControlAreaDesignation
    - ResourceAwardInstruction
    - RUCAwardInstruction
    - Domain
    - ExPostResourceResults
    - LoadFollowingOperatorInput
    - MarketObjectStatus
    - DefaultBid
    - ResourceCertification
    - FormerReference
    - IntermittentResourceEligibility
    - ResourceCapacity
    - ExpectedEnergyValues
    - ResourceLoadFollowingInst
    - ResourceDispatchResults
    - LoadFollowingInst
    - AllocationResultValues
    - Commitments
    - RMROperatorInput
    - OrgResOwnership
    - DispatchInstReply
    - ForbiddenRegion
    - ResourcePerformanceRating
    - ResponseMethod
    range: RegisteredResource
    required: false
class_uri: cim:ForbiddenRegion

Induced

name: ForbiddenRegion
description: "Forbbiden region is operating ranges where the units are unable to maintain\
  \ steady operation without causing equipment damage.  The four attributes that define\
  \ a forbidden region are the low MW, the High MW, the crossing time, and the crossing\
  \ cost.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  crossing_cost:
    name: crossing_cost
    description: "Cost associated with crossing the forbidden region\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ForbiddenRegion.crossingCost
    multivalued: false
    alias: crossing_cost
    owner: ForbiddenRegion
    domain_of:
    - ForbiddenRegion
    range: float
    required: false
  cross_time:
    name: cross_time
    description: "Time to cross the forbidden region in minutes.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ForbiddenRegion.crossTime
    multivalued: false
    alias: cross_time
    owner: ForbiddenRegion
    domain_of:
    - ForbiddenRegion
    range: integer
    required: false
  high_mw:
    name: high_mw
    description: "High end of the region definition\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ForbiddenRegion.highMW
    multivalued: false
    alias: high_mw
    owner: ForbiddenRegion
    domain_of:
    - ForbiddenRegion
    range: float
    required: false
  low_mw:
    name: low_mw
    description: "Low end of the region definition.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ForbiddenRegion.lowMW
    multivalued: false
    alias: low_mw
    owner: ForbiddenRegion
    domain_of:
    - ForbiddenRegion
    range: float
    required: false
  registered_resource:
    name: registered_resource
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:ForbiddenRegion.RegisteredResource
    multivalued: true
    alias: registered_resource
    owner: ForbiddenRegion
    domain_of:
    - TimeSeries
    - Reason
    - DotInstruction
    - MarketParticipant
    - MPMResourceStatus
    - MPMTestThreshold
    - SubControlArea
    - AdjacentCASet
    - HostControlArea
    - RampRateCurve
    - SchedulingPoint
    - ResourceVerifiableCosts
    - ContractDistributionFactor
    - SubstitutionResourceList
    - MktConnectivityNode
    - AggregateNode
    - Instructions
    - ControlAreaDesignation
    - ResourceAwardInstruction
    - RUCAwardInstruction
    - Domain
    - ExPostResourceResults
    - LoadFollowingOperatorInput
    - MarketObjectStatus
    - DefaultBid
    - ResourceCertification
    - FormerReference
    - IntermittentResourceEligibility
    - ResourceCapacity
    - ExpectedEnergyValues
    - ResourceLoadFollowingInst
    - ResourceDispatchResults
    - LoadFollowingInst
    - AllocationResultValues
    - Commitments
    - RMROperatorInput
    - OrgResOwnership
    - DispatchInstReply
    - ForbiddenRegion
    - ResourcePerformanceRating
    - ResponseMethod
    range: RegisteredResource
    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: ForbiddenRegion
    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: ForbiddenRegion
    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: ForbiddenRegion
    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: ForbiddenRegion
    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: ForbiddenRegion
    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: ForbiddenRegion
    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: ForbiddenRegion
    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: ForbiddenRegion
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:ForbiddenRegion