Class: PanDisplay

_PAN action/command used to issue the displaying of text messages on PAN devices. _

__

 classDiagram
    class PanDisplay
      EndDeviceAction <|-- PanDisplay

      PanDisplay : command

      PanDisplay : confirmation_required

      PanDisplay : duration

          PanDisplay --> Minutes : duration

      PanDisplay : duration_indefinite

      PanDisplay : end_device_control

          PanDisplay --> EndDeviceControl : end_device_control

      PanDisplay : priority

      PanDisplay : start_date_time

      PanDisplay : text_message

      PanDisplay : transmission_mode

          PanDisplay --> TransmissionModeKind : transmission_mode

Inheritance

EndDeviceAction
- PanDisplay

Slots

Name	Cardinality and Range	Description	Inheritance
confirmation_required	0..1 Boolean	If true, the requesting entity (e	direct
priority	0..1 String	Priority associated with the text message to be displayed	direct
text_message	0..1 String	Text to be displayed by a PAN device	direct
transmission_mode	0..1 TransmissionModeKind	Transmission mode to be used for this PAN display control	direct
command	0..1 String	Command text	EndDeviceAction
duration	0..1 Minutes	Amount of time the action of this control is to remain active	EndDeviceAction
duration_indefinite	0..1 Boolean	True if the action of this control is indefinite	EndDeviceAction
start_date_time	0..1 date	Start date and time for action of this control	EndDeviceAction
end_device_control	0..1 EndDeviceControl	End device control issuing this end device action	EndDeviceAction

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: PanDisplay
description: "PAN action/command used to issue the displaying of text messages on\
  \ PAN devices.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: EndDeviceAction
attributes:
  confirmation_required:
    name: confirmation_required
    description: "If true, the requesting entity (e.g. retail electric provider) requires\
      \ confirmation of the successful display of the text message.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDisplay.confirmationRequired
    multivalued: false
    domain_of:
    - PanDisplay
    range: boolean
    required: false
  priority:
    name: priority
    description: "Priority associated with the text message to be displayed.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PanDisplay.priority
    multivalued: false
    domain_of:
    - BusNameMarker
    - Customer
    - BaseWork
    - StageTrigger
    - Stage
    - AltGeneratingUnitMeas
    - AltTieMeas
    - PanDisplay
    - BidTimeSeries
    range: string
    required: false
  text_message:
    name: text_message
    description: "Text to be displayed by a PAN device.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PanDisplay.textMessage
    multivalued: false
    domain_of:
    - EndDeviceCapability
    - PanDisplay
    range: string
    required: false
  transmission_mode:
    name: transmission_mode
    description: "Transmission mode to be used for this PAN display control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDisplay.transmissionMode
    multivalued: false
    domain_of:
    - PanDisplay
    range: TransmissionModeKind
    required: false
class_uri: cim:PanDisplay

Induced

name: PanDisplay
description: "PAN action/command used to issue the displaying of text messages on\
  \ PAN devices.\r\n"
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: EndDeviceAction
attributes:
  confirmation_required:
    name: confirmation_required
    description: "If true, the requesting entity (e.g. retail electric provider) requires\
      \ confirmation of the successful display of the text message.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDisplay.confirmationRequired
    multivalued: false
    alias: confirmation_required
    owner: PanDisplay
    domain_of:
    - PanDisplay
    range: boolean
    required: false
  priority:
    name: priority
    description: "Priority associated with the text message to be displayed.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PanDisplay.priority
    multivalued: false
    alias: priority
    owner: PanDisplay
    domain_of:
    - BusNameMarker
    - Customer
    - BaseWork
    - StageTrigger
    - Stage
    - AltGeneratingUnitMeas
    - AltTieMeas
    - PanDisplay
    - BidTimeSeries
    range: string
    required: false
  text_message:
    name: text_message
    description: "Text to be displayed by a PAN device.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:PanDisplay.textMessage
    multivalued: false
    alias: text_message
    owner: PanDisplay
    domain_of:
    - EndDeviceCapability
    - PanDisplay
    range: string
    required: false
  transmission_mode:
    name: transmission_mode
    description: "Transmission mode to be used for this PAN display control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:PanDisplay.transmissionMode
    multivalued: false
    alias: transmission_mode
    owner: PanDisplay
    domain_of:
    - PanDisplay
    range: TransmissionModeKind
    required: false
  command:
    name: command
    description: "Command text.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceAction.command
    multivalued: false
    alias: command
    owner: PanDisplay
    domain_of:
    - EndDeviceAction
    - DiscreteValue
    range: string
    required: false
  duration:
    name: duration
    description: "Amount of time the action of this control is to remain active.\r\
      \n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceAction.duration
    multivalued: false
    alias: duration
    owner: PanDisplay
    domain_of:
    - GateInputPin
    - EndDeviceTiming
    - EndDeviceAction
    - ConstraintDuration
    - MarketScheduledEvent
    - ClassificationCondition
    - ScheduledEvent
    range: Minutes
    required: false
  duration_indefinite:
    name: duration_indefinite
    description: "True if the action of this control is indefinite.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:EndDeviceAction.durationIndefinite
    multivalued: false
    alias: duration_indefinite
    owner: PanDisplay
    domain_of:
    - EndDeviceTiming
    - EndDeviceAction
    range: boolean
    required: false
  start_date_time:
    name: start_date_time
    description: "Start date and time for action of this control.\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceAction.startDateTime
    multivalued: false
    alias: start_date_time
    owner: PanDisplay
    domain_of:
    - EndDeviceAction
    - CRRSegment
    - ProfileData
    range: date
    required: false
  end_device_control:
    name: end_device_control
    description: End device control issuing this end device action.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:EndDeviceAction.EndDeviceControl
    multivalued: false
    alias: end_device_control
    owner: PanDisplay
    domain_of:
    - EndDeviceAction
    range: EndDeviceControl
    required: false
class_uri: cim:PanDisplay