Skip to content

Class: DatasetArg

A model operation argument referencing a dataset instance.

URI: cim:DatasetArg

 classDiagram
    class DatasetArg
      ModelOperationArg <|-- DatasetArg

      DatasetArg : alias_name

      DatasetArg : dataset

          DatasetArg --> InstanceSet : dataset

      DatasetArg : description

      DatasetArg : diagram_objects

          DatasetArg --> DiagramObject : diagram_objects

      DatasetArg : instance_set

          DatasetArg --> InstanceSet : instance_set

      DatasetArg : m_rid

      DatasetArg : model_operation

          DatasetArg --> ModelOperation : model_operation

      DatasetArg : names

          DatasetArg --> Name : names

      DatasetArg : operation_dataset_arg_description

          DatasetArg --> DatasetArgDescription : operation_dataset_arg_description

      DatasetArg : properties_cimdata_object

          DatasetArg --> ChangeSetMember : properties_cimdata_object

      DatasetArg : sequence_number

      DatasetArg : targeting_cimdata_object

          DatasetArg --> ChangeSetMember : targeting_cimdata_object

Inheritance

Slots

Name Cardinality and Range Description Inheritance
operation_dataset_arg_description 1..1
DatasetArgDescription		 The type of role for this dataset role direct
dataset 1..1
InstanceSet		 Dataset referenced by this argument of a model operation direct
sequence_number 0..1
Integer		 The sequence number of the argument in an operation ModelOperationArg
model_operation 1..1
ModelOperation		 The opeation for the operation argument ModelOperationArg
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
InstanceSet dataset_arg range DatasetArg
DatasetArgDescription operation_dataset_arg range DatasetArg

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: DatasetArg
description: A model operation argument referencing a dataset instance.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: ModelOperationArg
attributes:
  operation_dataset_arg_description:
    name: operation_dataset_arg_description
    description: The type of role for this dataset role.   Should only reference role
      types that belong to the operation type of the associated operation.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DatasetArg.OperationDatasetArgDescription
    multivalued: false
    domain_of:
    - ModelOperationDescription
    - DatasetArg
    range: DatasetArgDescription
    required: true
  dataset:
    name: dataset
    description: Dataset referenced by this argument of a model operation..
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DatasetArg.Dataset
    multivalued: false
    domain_of:
    - AlternateModel
    - DatasetArg
    range: InstanceSet
    required: true
class_uri: cim:DatasetArg

Induced

name: DatasetArg
description: A model operation argument referencing a dataset instance.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: ModelOperationArg
attributes:
  operation_dataset_arg_description:
    name: operation_dataset_arg_description
    description: The type of role for this dataset role.   Should only reference role
      types that belong to the operation type of the associated operation.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DatasetArg.OperationDatasetArgDescription
    multivalued: false
    alias: operation_dataset_arg_description
    owner: DatasetArg
    domain_of:
    - ModelOperationDescription
    - DatasetArg
    range: DatasetArgDescription
    required: true
  dataset:
    name: dataset
    description: Dataset referenced by this argument of a model operation..
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:DatasetArg.Dataset
    multivalued: false
    alias: dataset
    owner: DatasetArg
    domain_of:
    - AlternateModel
    - DatasetArg
    range: InstanceSet
    required: true
  sequence_number:
    name: sequence_number
    description: "The sequence number of the argument in an operation.  Argument entries\
      \ are considered in numerical order where the operation requires an ordering.\
      \ \r\n "
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ModelOperationArg.sequenceNumber
    multivalued: false
    alias: sequence_number
    owner: DatasetArg
    domain_of:
    - ModelOperationArg
    - ModelOperation
    - DiagramObjectPoint
    - ACDCTerminal
    - WorkFlowStep
    - SwitchingStep
    - SwitchingStepGroup
    - FieldDispatchStep
    - UserAttribute
    - Procedure
    - TimeTariffInterval
    - ConsumptionTariffInterval
    - WirePosition
    - ACLineSegmentPhase
    - RegularTimePoint
    - TimePoint
    - PositionPoint
    - WireSegmentPhase
    - ProfileData
    range: integer
    required: false
  model_operation:
    name: model_operation
    description: The opeation for the operation argument.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:ModelOperationArg.ModelOperation
    multivalued: false
    alias: model_operation
    owner: DatasetArg
    domain_of:
    - ModelOperationArg
    - ModelOperationSequence
    - ModelOperationDescription
    range: ModelOperation
    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: DatasetArg
    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: DatasetArg
    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: DatasetArg
    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: DatasetArg
    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: DatasetArg
    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: DatasetArg
    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: DatasetArg
    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: DatasetArg
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:DatasetArg