Skip to content

Class: EnvironmentalAlert

An environmental alert issued by a provider or system.

URI: cim:EnvironmentalAlert

 classDiagram
    class EnvironmentalAlert
      ActivityRecord <|-- EnvironmentalAlert

      EnvironmentalAlert : alert_type

      EnvironmentalAlert : alert_type_list

          EnvironmentalAlert --> AlertTypeList : alert_type_list

      EnvironmentalAlert : alias_name

      EnvironmentalAlert : assets

          EnvironmentalAlert --> Asset : assets

      EnvironmentalAlert : author

          EnvironmentalAlert --> Author : author

      EnvironmentalAlert : cancelled_date_time

      EnvironmentalAlert : created_date_time

      EnvironmentalAlert : description

      EnvironmentalAlert : diagram_objects

          EnvironmentalAlert --> DiagramObject : diagram_objects

      EnvironmentalAlert : document

          EnvironmentalAlert --> Document : document

      EnvironmentalAlert : environmental_data_provider

          EnvironmentalAlert --> EnvironmentalDataProvider : environmental_data_provider

      EnvironmentalAlert : environmental_location_kind

          EnvironmentalAlert --> EnvironmentalLocationType : environmental_location_kind

      EnvironmentalAlert : headline

      EnvironmentalAlert : in_effect

          EnvironmentalAlert --> DateTimeInterval : in_effect

      EnvironmentalAlert : instance_set

          EnvironmentalAlert --> InstanceSet : instance_set

      EnvironmentalAlert : m_rid

      EnvironmentalAlert : names

          EnvironmentalAlert --> Name : names

      EnvironmentalAlert : properties_cimdata_object

          EnvironmentalAlert --> ChangeSetMember : properties_cimdata_object

      EnvironmentalAlert : reason

      EnvironmentalAlert : severity

      EnvironmentalAlert : status

          EnvironmentalAlert --> Status : status

      EnvironmentalAlert : targeting_cimdata_object

          EnvironmentalAlert --> ChangeSetMember : targeting_cimdata_object

      EnvironmentalAlert : type

Inheritance

Slots

Name Cardinality and Range Description Inheritance
alert_type 0..1
String		 The type of the issued alert which is drawn from the specified alert type lis... direct
cancelled_date_time 0..1
date		 Time and date alert cancelled direct
headline 0..1
String		 An abbreviated textual description of the alert issued direct
in_effect 0..1
DateTimeInterval		 The interval for which this weather alert is in effect direct
alert_type_list 1..1
AlertTypeList		 The list of alert types from which the type of this alert is drawn direct
environmental_location_kind 1..*
EnvironmentalLocationType		 Type of location to which this environmental alert applies direct
environmental_data_provider 0..1
EnvironmentalDataProvider		 Environmental data provider for this alert 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
EnvironmentalLocationType environmental_alert range EnvironmentalAlert
AlertTypeList environmental_alert range EnvironmentalAlert
EnvironmentalDataProvider environmental_alert range EnvironmentalAlert

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: EnvironmentalAlert
description: An environmental alert issued by a provider or system.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: ActivityRecord
attributes:
  alert_type:
    name: alert_type
    description: 'The type of the issued alert which is drawn from the specified alert
      type list. '
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EnvironmentalAlert.alertType
    multivalued: false
    domain_of:
    - EnvironmentalAlert
    range: string
    required: false
  cancelled_date_time:
    name: cancelled_date_time
    description: Time and date alert cancelled. Used only if alert is cancelled before
      it expires.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnvironmentalAlert.cancelledDateTime
    multivalued: false
    domain_of:
    - SwitchingPlan
    - OutagePlan
    - EnvironmentalAlert
    range: date
    required: false
  headline:
    name: headline
    description: "An abbreviated textual description of the alert issued. \r\nNote:\
      \ the full text of the alert appears in the .description attribute (inherited\
      \ from IdentifiedObject)."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EnvironmentalAlert.headline
    multivalued: false
    domain_of:
    - EnvironmentalAlert
    range: string
    required: false
  in_effect:
    name: in_effect
    description: The interval for which this weather alert is in effect.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EnvironmentalAlert.inEffect
    multivalued: false
    domain_of:
    - EnvironmentalAlert
    range: DateTimeInterval
    required: false
  alert_type_list:
    name: alert_type_list
    description: The list of alert types from which the type of this alert is drawn.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EnvironmentalAlert.AlertTypeList
    multivalued: false
    domain_of:
    - EnvironmentalAlert
    - EnvironmentalDataAuthority
    range: AlertTypeList
    required: true
  environmental_location_kind:
    name: environmental_location_kind
    description: Type of location to which this environmental alert applies.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnvironmentalAlert.EnvironmentalLocationKind
    multivalued: true
    domain_of:
    - Location
    - EnvironmentalPhenomenon
    - EnvironmentalAlert
    range: EnvironmentalLocationType
    required: true
  environmental_data_provider:
    name: environmental_data_provider
    description: Environmental data provider for this alert.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnvironmentalAlert.EnvironmentalDataProvider
    multivalued: false
    domain_of:
    - EnvironmentalInformation
    - EnvironmentalAlert
    range: EnvironmentalDataProvider
    required: false
class_uri: cim:EnvironmentalAlert

Induced

name: EnvironmentalAlert
description: An environmental alert issued by a provider or system.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: ActivityRecord
attributes:
  alert_type:
    name: alert_type
    description: 'The type of the issued alert which is drawn from the specified alert
      type list. '
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EnvironmentalAlert.alertType
    multivalued: false
    alias: alert_type
    owner: EnvironmentalAlert
    domain_of:
    - EnvironmentalAlert
    range: string
    required: false
  cancelled_date_time:
    name: cancelled_date_time
    description: Time and date alert cancelled. Used only if alert is cancelled before
      it expires.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnvironmentalAlert.cancelledDateTime
    multivalued: false
    alias: cancelled_date_time
    owner: EnvironmentalAlert
    domain_of:
    - SwitchingPlan
    - OutagePlan
    - EnvironmentalAlert
    range: date
    required: false
  headline:
    name: headline
    description: "An abbreviated textual description of the alert issued. \r\nNote:\
      \ the full text of the alert appears in the .description attribute (inherited\
      \ from IdentifiedObject)."
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EnvironmentalAlert.headline
    multivalued: false
    alias: headline
    owner: EnvironmentalAlert
    domain_of:
    - EnvironmentalAlert
    range: string
    required: false
  in_effect:
    name: in_effect
    description: The interval for which this weather alert is in effect.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EnvironmentalAlert.inEffect
    multivalued: false
    alias: in_effect
    owner: EnvironmentalAlert
    domain_of:
    - EnvironmentalAlert
    range: DateTimeInterval
    required: false
  alert_type_list:
    name: alert_type_list
    description: The list of alert types from which the type of this alert is drawn.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EnvironmentalAlert.AlertTypeList
    multivalued: false
    alias: alert_type_list
    owner: EnvironmentalAlert
    domain_of:
    - EnvironmentalAlert
    - EnvironmentalDataAuthority
    range: AlertTypeList
    required: true
  environmental_location_kind:
    name: environmental_location_kind
    description: Type of location to which this environmental alert applies.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnvironmentalAlert.EnvironmentalLocationKind
    multivalued: true
    alias: environmental_location_kind
    owner: EnvironmentalAlert
    domain_of:
    - Location
    - EnvironmentalPhenomenon
    - EnvironmentalAlert
    range: EnvironmentalLocationType
    required: true
  environmental_data_provider:
    name: environmental_data_provider
    description: Environmental data provider for this alert.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EnvironmentalAlert.EnvironmentalDataProvider
    multivalued: false
    alias: environmental_data_provider
    owner: EnvironmentalAlert
    domain_of:
    - EnvironmentalInformation
    - EnvironmentalAlert
    range: EnvironmentalDataProvider
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    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: EnvironmentalAlert
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:EnvironmentalAlert