Skip to content

Class: EnvironmentalEvent

_An environmental event to which one or more forecasts or observations may be tied and which may relate to or affect one or more assets. _

_This class is intended to be used as a means of grouping forecasts and/or observations and could be used for a variety of purposes, including: _

_

    _

_

  • to define a 'named' event like Hurricane Katrina and allow the historic (or forecast) values for phenomena and measurements (precipitation, temperature) across time to be associated with it
  • _

    _

  • to identify assets that were (or are forecast to be) affected by a phenomenon or set of measurements
  • _

    URI: cim:EnvironmentalEvent

     classDiagram
        class EnvironmentalEvent
          ActivityRecord <|-- EnvironmentalEvent
    
          EnvironmentalEvent : alias_name
    
          EnvironmentalEvent : assets
    
              EnvironmentalEvent --> Asset : assets
    
          EnvironmentalEvent : author
    
              EnvironmentalEvent --> Author : author
    
          EnvironmentalEvent : created_date_time
    
          EnvironmentalEvent : description
    
          EnvironmentalEvent : diagram_objects
    
              EnvironmentalEvent --> DiagramObject : diagram_objects
    
          EnvironmentalEvent : document
    
              EnvironmentalEvent --> Document : document
    
          EnvironmentalEvent : environmental_information
    
              EnvironmentalEvent --> EnvironmentalInformation : environmental_information
    
          EnvironmentalEvent : instance_set
    
              EnvironmentalEvent --> InstanceSet : instance_set
    
          EnvironmentalEvent : m_rid
    
          EnvironmentalEvent : names
    
              EnvironmentalEvent --> Name : names
    
          EnvironmentalEvent : properties_cimdata_object
    
              EnvironmentalEvent --> ChangeSetMember : properties_cimdata_object
    
          EnvironmentalEvent : reason
    
          EnvironmentalEvent : severity
    
          EnvironmentalEvent : status
    
              EnvironmentalEvent --> Status : status
    
          EnvironmentalEvent : targeting_cimdata_object
    
              EnvironmentalEvent --> ChangeSetMember : targeting_cimdata_object
    
          EnvironmentalEvent : type
    
    

    Inheritance

    Slots

    Name Cardinality and Range Description Inheritance
    environmental_information 0..*
    EnvironmentalInformation
    Forecast or observation related to this environmental event direct
    created_date_time 0..1
    date
    Date and time this activity record has been created (different from the 'stat... ActivityRecord
    reason 0..1
    String
    Reason for event resulting in this activity record, typically supplied when u... ActivityRecord
    severity 0..1
    String
    Severity level of event resulting in this activity record ActivityRecord
    status 0..1
    Status
    Information on consequence of event resulting in this activity record ActivityRecord
    type 0..1
    String
    Type of event resulting in this activity record ActivityRecord
    document 0..1
    Document
    The document having associated activity records ActivityRecord
    author 0..1
    Author
    Author of this activity record ActivityRecord
    assets 0..*
    Asset
    All assets for which this activity record has been created ActivityRecord
    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
    EnvironmentalInformation environmental_event range EnvironmentalEvent
    Forecast environmental_event range EnvironmentalEvent
    Observation environmental_event range EnvironmentalEvent

    Identifier and Mapping Information

    Schema Source

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

    Mappings

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

    LinkML Source

    Direct

    name: EnvironmentalEvent
    description: "An environmental event to which one or more forecasts or observations\
      \ may be tied and which may relate to or affect one or more assets.\r\nThis class\
      \ is intended to be used as a means of grouping forecasts and/or observations and\
      \ could be used for a variety of purposes, including:\r\n<ul>\r\n\t<li>to define\
      \ a 'named' event like Hurricane Katrina and allow the historic (or forecast) values\
      \ for phenomena and measurements (precipitation, temperature) across time to be\
      \  associated with it</li>\r\n\t<li>to identify assets that were (or are forecast\
      \ to be) affected by a phenomenon or set of measurements</li>\r\n</ul>"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    is_a: ActivityRecord
    attributes:
      environmental_information:
        name: environmental_information
        description: Forecast or observation related to this environmental event.
        from_schema: https://cim.ucaiug.io/ns#TC57CIM
        slot_uri: cim:EnvironmentalEvent.EnvironmentalInformation
        multivalued: true
        domain_of:
        - EnvironmentalAnalog
        - EnvironmentalStringMeasurement
        - EnvironmentalPhenomenon
        - EnvironmentalDataProvider
        - EnvironmentalEvent
        - EnvironmentalDiscrete
        range: EnvironmentalInformation
        required: false
    class_uri: cim:EnvironmentalEvent
    

    Induced

    name: EnvironmentalEvent
    description: "An environmental event to which one or more forecasts or observations\
      \ may be tied and which may relate to or affect one or more assets.\r\nThis class\
      \ is intended to be used as a means of grouping forecasts and/or observations and\
      \ could be used for a variety of purposes, including:\r\n<ul>\r\n\t<li>to define\
      \ a 'named' event like Hurricane Katrina and allow the historic (or forecast) values\
      \ for phenomena and measurements (precipitation, temperature) across time to be\
      \  associated with it</li>\r\n\t<li>to identify assets that were (or are forecast\
      \ to be) affected by a phenomenon or set of measurements</li>\r\n</ul>"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    is_a: ActivityRecord
    attributes:
      environmental_information:
        name: environmental_information
        description: Forecast or observation related to this environmental event.
        from_schema: https://cim.ucaiug.io/ns#TC57CIM
        slot_uri: cim:EnvironmentalEvent.EnvironmentalInformation
        multivalued: true
        alias: environmental_information
        owner: EnvironmentalEvent
        domain_of:
        - EnvironmentalAnalog
        - EnvironmentalStringMeasurement
        - EnvironmentalPhenomenon
        - EnvironmentalDataProvider
        - EnvironmentalEvent
        - EnvironmentalDiscrete
        range: EnvironmentalInformation
        required: false
      created_date_time:
        name: created_date_time
        description: "Date and time this activity record has been created (different from\
          \ the 'status.dateTime', which is the time of a status change of the associated\
          \ object, if applicable).\r\n"
        from_schema: https://cim.ucaiug.io/ns#TC57CIM
        slot_uri: cim:ActivityRecord.createdDateTime
        multivalued: false
        alias: created_date_time
        owner: EnvironmentalEvent
        domain_of:
        - Document
        - ActivityRecord
        range: date
        required: false
      reason:
        name: reason
        description: Reason for event resulting in this activity record, typically supplied
          when user initiated.
        from_schema: https://cim.ucaiug.io/ns#TC57CIM
        slot_uri: cim:ActivityRecord.reason
        multivalued: false
        alias: reason
        owner: EnvironmentalEvent
        domain_of:
        - Status
        - PlannedOutage
        - ActivityRecord
        - AccountMovement
        - Reading
        - EndDeviceControl
        - MetrologyRequirement
        - TimeSeries
        - MarketDocument
        - Point
        - RegisteredResource
        - EnergyTransaction
        - Period
        range: string
        required: false
      severity:
        name: severity
        description: Severity level of event resulting in this activity record.
        from_schema: https://cim.ucaiug.io/ns#TC57CIM
        rank: 1000
        slot_uri: cim:ActivityRecord.severity
        multivalued: false
        alias: severity
        owner: EnvironmentalEvent
        domain_of:
        - ActivityRecord
        range: string
        required: false
      status:
        name: status
        description: Information on consequence of event resulting in this activity record.
        from_schema: https://cim.ucaiug.io/ns#TC57CIM
        slot_uri: cim:ActivityRecord.status
        multivalued: false
        alias: status
        owner: EnvironmentalEvent
        domain_of:
        - Asset
        - Document
        - Customer
        - StreetAddress
        - Location
        - ErpQuoteLineItem
        - CostType
        - ErpJournalEntry
        - ErpRecLineItem
        - ErpPayableLineItem
        - ContractorItem
        - Capability
        - Craft
        - OldPerson
        - ErpPersonnel
        - LaborItem
        - DesignLocationCU
        - DesignLocation
        - ConditionFactor
        - MiscCostItem
        - CUGroup
        - WorkFlowStep
        - ErpTimeEntry
        - OverheadCost
        - PropertyUnit
        - CUMaterialItem
        - ErpIssueInventory
        - ErpReqLineItem
        - ErpRecDelvLineItem
        - Role
        - LandProperty
        - ErpSiteLevelData
        - Crew
        - ActivityRecord
        - ErpLedgerEntry
        - ErpLedBudLineItem
        - TransformerObservation
        - BushingInsulationPF
        - WindingInsulation
        - CULaborItem
        - CULaborCode
        - EndDeviceGroup
        - Hazard
        - CUWorkEquipmentItem
        - ShiftPattern
        - Route
        - Usage
        - CUContractorItem
        - CUAllowableAction
        - TypeAssetCatalogue
        - AssetModelCatalogue
        - Market
        - CRROrgRole
        - MarketScheduledEvent
        - MarketLedgerEntry
        - MarketPerson
        - MarketQualificationRequirement
        - ResourceGroup
        - ResourceAwardInstruction
        - ExPostResourceResults
        - MarketObjectStatus
        - TimePoint
        - ErpItemMaster
        - ScheduledEvent
        - ScheduledEventData
        - ErpInventory
        - ErpInventoryCount
        - RedLine
        - BusinessRole
        - BidTimeSeries
        range: Status
        required: false
      type:
        name: type
        description: "Type of event resulting in this activity record.\r\n"
        from_schema: https://cim.ucaiug.io/ns#TC57CIM
        slot_uri: cim:ActivityRecord.type
        multivalued: false
        alias: type
        owner: EnvironmentalEvent
        domain_of:
        - Asset
        - AcceptanceTest
        - Document
        - StreetDetail
        - Location
        - Priority
        - CatalogAssetType
        - Capability
        - Craft
        - OldPerson
        - Role
        - ActivityRecord
        - EndDeviceEventType
        - EndDeviceGroup
        - DemandResponseProgram
        - UsagePointGroup
        - EndDeviceControlType
        - Hazard
        - OldCrew
        - Route
        - ConstraintDuration
        - AceTariffType
        - ControlArea
        - SynchronousMachine
        - ChargeProfile
        - ChargeComponent
        - MarketRole
        - ResourceGroup
        - Quantity
        - ResourceCertification
        - Auction
        - ScheduledEvent
        - PotentialTransformer
        - BusinessRole
        range: string
        required: false
      document:
        name: document
        description: The document having associated activity records
        from_schema: https://cim.ucaiug.io/ns#TC57CIM
        rank: 1000
        slot_uri: cim:ActivityRecord.Document
        multivalued: false
        alias: document
        owner: EnvironmentalEvent
        domain_of:
        - ActivityRecord
        range: Document
        required: false
      author:
        name: author
        description: Author of this activity record.
        from_schema: https://cim.ucaiug.io/ns#TC57CIM
        slot_uri: cim:ActivityRecord.Author
        multivalued: false
        alias: author
        owner: EnvironmentalEvent
        domain_of:
        - Document
        - ActivityRecord
        range: Author
        required: false
      assets:
        name: assets
        description: All assets for which this activity record has been created.
        from_schema: https://cim.ucaiug.io/ns#TC57CIM
        slot_uri: cim:ActivityRecord.Assets
        multivalued: true
        alias: assets
        owner: EnvironmentalEvent
        domain_of:
        - PowerSystemResource
        - AssetInfo
        - Location
        - WorkTask
        - ErpRecDelvLineItem
        - AssetContainer
        - ActivityRecord
        - Procedure
        - ReliabilityInfo
        - AssetPropertyCurve
        - AssetOrganisationRole
        - ScheduledEvent
        range: Asset
        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: EnvironmentalEvent
        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: EnvironmentalEvent
        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: EnvironmentalEvent
        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: EnvironmentalEvent
        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: EnvironmentalEvent
        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: EnvironmentalEvent
        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: EnvironmentalEvent
        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: EnvironmentalEvent
        domain_of:
        - IdentifiedObject
        range: ChangeSetMember
        required: false
    class_uri: cim:EnvironmentalEvent