Skip to content

Class: PinBranchGroup

Value associated with branch group is used as compare.

URI: cim:PinBranchGroup

 classDiagram
    class PinBranchGroup
      GateInputPin <|-- PinBranchGroup

      PinBranchGroup : a_dlogic_kind

          PinBranchGroup --> AnalogToDigitalLogicKind : a_dlogic_kind

      PinBranchGroup : absolute_value

      PinBranchGroup : alias_name

      PinBranchGroup : branch_group

          PinBranchGroup --> BranchGroup : branch_group

      PinBranchGroup : description

      PinBranchGroup : diagram_objects

          PinBranchGroup --> DiagramObject : diagram_objects

      PinBranchGroup : duration

          PinBranchGroup --> Seconds : duration

      PinBranchGroup : gate

          PinBranchGroup --> Gate : gate

      PinBranchGroup : instance_set

          PinBranchGroup --> InstanceSet : instance_set

      PinBranchGroup : kind

          PinBranchGroup --> PinBranchGroupKind : kind

      PinBranchGroup : m_rid

      PinBranchGroup : names

          PinBranchGroup --> Name : names

      PinBranchGroup : negate

      PinBranchGroup : properties_cimdata_object

          PinBranchGroup --> ChangeSetMember : properties_cimdata_object

      PinBranchGroup : targeting_cimdata_object

          PinBranchGroup --> ChangeSetMember : targeting_cimdata_object

      PinBranchGroup : threshold_percentage

          PinBranchGroup --> PerCent : threshold_percentage

      PinBranchGroup : threshold_value

Inheritance

Slots

Name Cardinality and Range Description Inheritance
kind 0..1
PinBranchGroupKind
The compare operation done on the branch group direct
branch_group 1..1
BranchGroup
The branch group that should be used in compare direct
absolute_value 0..1
Boolean
If true, use the absolute value for compare GateInputPin
a_dlogic_kind 0..1
AnalogToDigitalLogicKind
The compare operation GateInputPin
duration 0..1
Seconds
The duration the compare condition need to be present before given a true GateInputPin
negate 0..1
Boolean
Invert/negate the result of the compare GateInputPin
threshold_percentage 0..1
PerCent
The threshold percentage that should be used for compare with the percentage ... GateInputPin
threshold_value 0..1
Float
The threshold value that should be used for compare with the input value GateInputPin
gate 1..1
Gate
GateInputPin
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
BranchGroup pin_branch_group range PinBranchGroup

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: PinBranchGroup
description: Value associated with branch group is used as compare.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: GateInputPin
attributes:
  kind:
    name: kind
    description: The compare operation done on the branch group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PinBranchGroup.kind
    multivalued: false
    domain_of:
    - Asset
    - Customer
    - BaseWork
    - WorkTimeSchedule
    - CustomerBillingInfo
    - ErpInvoiceLineItem
    - CatalogAssetType
    - Design
    - ConditionFactor
    - LandProperty
    - Seal
    - Gate
    - JumperAction
    - RevisionHistory
    - SwitchAction
    - Fault
    - ServiceCategory
    - Transaction
    - Procedure
    - Medium
    - Tender
    - Cheque
    - Charge
    - ServiceRequest
    - MeterMultiplier
    - StructureSupport
    - CutAction
    - GroundAction
    - ClampAction
    - ProtectiveActionAdjustment
    - RemedialActionScheme
    - MeasurementCalculator
    - ErpInvoice
    - ServiceSupplier
    - EnergyTypeReference
    - CRROrgRole
    - MarketInvoice
    - MarketInvoiceLineItem
    - EnvironmentalLocationType
    - EnvironmentalDiscrete
    - ServiceMultiplier
    - AssetLocationHazard
    - Analytic
    - AssetGroup
    - TagAction
    - PinBranchGroup
    - PinTerminal
    - PinEquipment
    - ClearanceAction
    - PSREvent
    - ShuntCompensatorAction
    - EnergyConsumerAction
    - EnergySourceAction
    - Zone
    - OilAnalysisMoistureAnalog
    - AssetStringMeasurement
    - InspectionAnalog
    - AssetTemperaturePressureAnalog
    - OilAnalysisFluidDiscrete
    - InspectionDiscrete
    - OilAnalysisPCBDiscrete
    - OilAnalysisFluidAnalog
    - OilAnalysisGasAnalog
    - OilAnalysisPCBAnalog
    - OilAnalysisParticleDiscrete
    - OilAnalysisMetalsAnalog
    - OilAnalysisParticleAnalog
    - OilAnalysisPaperAnalog
    - CompositeSwitchInfo
    - Facility
    - RiskScore
    - FACTSDevice
    - SimpleEndDeviceFunction
    - UndergroundStructure
    - RelativeDisplacement
    - CloudCondition
    - GeosphericAnalog
    - HydrosphericAnalog
    - AtmosphericAnalog
    - SpaceAnalog
    range: PinBranchGroupKind
    required: false
  branch_group:
    name: branch_group
    description: The branch group that should be used in compare.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PinBranchGroup.BranchGroup
    multivalued: false
    domain_of:
    - BranchGroupTerminal
    - PinBranchGroup
    range: BranchGroup
    required: true
class_uri: cim:PinBranchGroup

Induced

name: PinBranchGroup
description: Value associated with branch group is used as compare.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: GateInputPin
attributes:
  kind:
    name: kind
    description: The compare operation done on the branch group.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PinBranchGroup.kind
    multivalued: false
    alias: kind
    owner: PinBranchGroup
    domain_of:
    - Asset
    - Customer
    - BaseWork
    - WorkTimeSchedule
    - CustomerBillingInfo
    - ErpInvoiceLineItem
    - CatalogAssetType
    - Design
    - ConditionFactor
    - LandProperty
    - Seal
    - Gate
    - JumperAction
    - RevisionHistory
    - SwitchAction
    - Fault
    - ServiceCategory
    - Transaction
    - Procedure
    - Medium
    - Tender
    - Cheque
    - Charge
    - ServiceRequest
    - MeterMultiplier
    - StructureSupport
    - CutAction
    - GroundAction
    - ClampAction
    - ProtectiveActionAdjustment
    - RemedialActionScheme
    - MeasurementCalculator
    - ErpInvoice
    - ServiceSupplier
    - EnergyTypeReference
    - CRROrgRole
    - MarketInvoice
    - MarketInvoiceLineItem
    - EnvironmentalLocationType
    - EnvironmentalDiscrete
    - ServiceMultiplier
    - AssetLocationHazard
    - Analytic
    - AssetGroup
    - TagAction
    - PinBranchGroup
    - PinTerminal
    - PinEquipment
    - ClearanceAction
    - PSREvent
    - ShuntCompensatorAction
    - EnergyConsumerAction
    - EnergySourceAction
    - Zone
    - OilAnalysisMoistureAnalog
    - AssetStringMeasurement
    - InspectionAnalog
    - AssetTemperaturePressureAnalog
    - OilAnalysisFluidDiscrete
    - InspectionDiscrete
    - OilAnalysisPCBDiscrete
    - OilAnalysisFluidAnalog
    - OilAnalysisGasAnalog
    - OilAnalysisPCBAnalog
    - OilAnalysisParticleDiscrete
    - OilAnalysisMetalsAnalog
    - OilAnalysisParticleAnalog
    - OilAnalysisPaperAnalog
    - CompositeSwitchInfo
    - Facility
    - RiskScore
    - FACTSDevice
    - SimpleEndDeviceFunction
    - UndergroundStructure
    - RelativeDisplacement
    - CloudCondition
    - GeosphericAnalog
    - HydrosphericAnalog
    - AtmosphericAnalog
    - SpaceAnalog
    range: PinBranchGroupKind
    required: false
  branch_group:
    name: branch_group
    description: The branch group that should be used in compare.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PinBranchGroup.BranchGroup
    multivalued: false
    alias: branch_group
    owner: PinBranchGroup
    domain_of:
    - BranchGroupTerminal
    - PinBranchGroup
    range: BranchGroup
    required: true
  absolute_value:
    name: absolute_value
    description: 'If true, use the absolute value for compare.. '
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:GateInputPin.absoluteValue
    multivalued: false
    alias: absolute_value
    owner: PinBranchGroup
    domain_of:
    - GateInputPin
    - MeasurementCalculatorInput
    range: boolean
    required: false
  a_dlogic_kind:
    name: a_dlogic_kind
    description: The compare operation.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:GateInputPin.aDLogicKind
    multivalued: false
    alias: a_dlogic_kind
    owner: PinBranchGroup
    domain_of:
    - GateInputPin
    range: AnalogToDigitalLogicKind
    required: false
  duration:
    name: duration
    description: The duration the compare condition need to be present before given
      a true. Default is 0 seconds.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:GateInputPin.duration
    multivalued: false
    alias: duration
    owner: PinBranchGroup
    domain_of:
    - GateInputPin
    - EndDeviceTiming
    - EndDeviceAction
    - ConstraintDuration
    - MarketScheduledEvent
    - ClassificationCondition
    - ScheduledEvent
    range: Seconds
    required: false
  negate:
    name: negate
    description: Invert/negate the result of the compare.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:GateInputPin.negate
    multivalued: false
    alias: negate
    owner: PinBranchGroup
    domain_of:
    - GateInputPin
    range: boolean
    required: false
  threshold_percentage:
    name: threshold_percentage
    description: The threshold percentage that should be used for compare with the
      percentage change between input value and threshold value.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:GateInputPin.thresholdPercentage
    multivalued: false
    alias: threshold_percentage
    owner: PinBranchGroup
    domain_of:
    - GateInputPin
    range: PerCent
    required: false
  threshold_value:
    name: threshold_value
    description: The threshold value that should be used for compare with the input
      value.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:GateInputPin.thresholdValue
    multivalued: false
    alias: threshold_value
    owner: PinBranchGroup
    domain_of:
    - GateInputPin
    range: float
    required: false
  gate:
    name: gate
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:GateInputPin.Gate
    multivalued: false
    alias: gate
    owner: PinBranchGroup
    domain_of:
    - GateInputPin
    range: Gate
    required: true
  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: PinBranchGroup
    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: PinBranchGroup
    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: PinBranchGroup
    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: PinBranchGroup
    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: PinBranchGroup
    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: PinBranchGroup
    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: PinBranchGroup
    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: PinBranchGroup
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:PinBranchGroup