Skip to content

Class: Auction

A class providing the identification and type of an auction.

URI: cim:Auction

 classDiagram
    class Auction
      IdentifiedObject <|-- Auction

      Auction : alias_name

      Auction : allocation_mode

      Auction : cancelled

      Auction : category

      Auction : description

      Auction : diagram_objects

          Auction --> DiagramObject : diagram_objects

      Auction : instance_set

          Auction --> InstanceSet : instance_set

      Auction : m_rid

      Auction : names

          Auction --> Name : names

      Auction : payment_terms

      Auction : properties_cimdata_object

          Auction --> ChangeSetMember : properties_cimdata_object

      Auction : rights

      Auction : targeting_cimdata_object

          Auction --> ChangeSetMember : targeting_cimdata_object

      Auction : time_series

          Auction --> TimeSeries : time_series

      Auction : type

Inheritance

Slots

Name Cardinality and Range Description Inheritance
allocation_mode 0..1
String
Identification of the method of allocation in an auction direct
cancelled 0..1
String
An indicator that signifies that the auction has been cancelled direct
category 0..1
String
The product category of an auction direct
payment_terms 0..1
String
The terms which dictate the determination of the bid payment price direct
rights 0..1
String
The rights of use the transmission capacity acquired in an auction direct
type 0..1
String
The kind of the Auction (e direct
time_series 0..*
TimeSeries
direct
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
TimeSeries auction range Auction
BidTimeSeries auction range Auction
Series auction range Auction

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: Auction
description: A class providing the identification and type of an auction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  allocation_mode:
    name: allocation_mode
    description: Identification of the method of allocation in an auction.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Auction.allocationMode
    multivalued: false
    domain_of:
    - Auction
    range: string
    required: false
  cancelled:
    name: cancelled
    description: An indicator that signifies that the auction has been cancelled.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Auction.cancelled
    multivalued: false
    domain_of:
    - Auction
    - PowerSystemProjectLifecycleToBeDeleted
    range: string
    required: false
  category:
    name: category
    description: The product category of an auction.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Auction.category
    multivalued: false
    domain_of:
    - ReadingQualityType
    - MarketScheduledEvent
    - MarketPerson
    - Price
    - Auction
    - Hurricane
    - TropicalCycloneAustralia
    range: string
    required: false
  payment_terms:
    name: payment_terms
    description: The terms which dictate the determination of the bid payment price.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Auction.paymentTerms
    multivalued: false
    domain_of:
    - Auction
    range: string
    required: false
  rights:
    name: rights
    description: The rights of use the transmission capacity acquired in an auction.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Auction.rights
    multivalued: false
    domain_of:
    - Auction
    range: string
    required: false
  type:
    name: type
    description: "The kind of the Auction (e.g. implicit, explicit ...).\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Auction.type
    multivalued: false
    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
  time_series:
    name: time_series
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Auction.TimeSeries
    multivalued: true
    domain_of:
    - EnvironmentalMonitoringStation
    - ConstraintDuration
    - AttributeInstanceComponent
    - MarketDocument
    - Point
    - Reason
    - RegisteredResource
    - MarketParticipant
    - Domain
    - Quantity
    - Price
    - MarketObjectStatus
    - Period
    - FlowDirection
    - Unit
    - DateAndOrTime
    - Auction
    - MktPSRType
    - MarketEvaluationPoint
    range: TimeSeries
    required: false
class_uri: cim:Auction

Induced

name: Auction
description: A class providing the identification and type of an auction.
from_schema: https://cim.ucaiug.io/ns#TC57CIM
rank: 1000
is_a: IdentifiedObject
attributes:
  allocation_mode:
    name: allocation_mode
    description: Identification of the method of allocation in an auction.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Auction.allocationMode
    multivalued: false
    alias: allocation_mode
    owner: Auction
    domain_of:
    - Auction
    range: string
    required: false
  cancelled:
    name: cancelled
    description: An indicator that signifies that the auction has been cancelled.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Auction.cancelled
    multivalued: false
    alias: cancelled
    owner: Auction
    domain_of:
    - Auction
    - PowerSystemProjectLifecycleToBeDeleted
    range: string
    required: false
  category:
    name: category
    description: The product category of an auction.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Auction.category
    multivalued: false
    alias: category
    owner: Auction
    domain_of:
    - ReadingQualityType
    - MarketScheduledEvent
    - MarketPerson
    - Price
    - Auction
    - Hurricane
    - TropicalCycloneAustralia
    range: string
    required: false
  payment_terms:
    name: payment_terms
    description: The terms which dictate the determination of the bid payment price.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Auction.paymentTerms
    multivalued: false
    alias: payment_terms
    owner: Auction
    domain_of:
    - Auction
    range: string
    required: false
  rights:
    name: rights
    description: The rights of use the transmission capacity acquired in an auction.
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    rank: 1000
    slot_uri: cim:Auction.rights
    multivalued: false
    alias: rights
    owner: Auction
    domain_of:
    - Auction
    range: string
    required: false
  type:
    name: type
    description: "The kind of the Auction (e.g. implicit, explicit ...).\r\n"
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Auction.type
    multivalued: false
    alias: type
    owner: Auction
    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
  time_series:
    name: time_series
    from_schema: https://cim.ucaiug.io/ns#TC57CIM
    slot_uri: cim:Auction.TimeSeries
    multivalued: true
    alias: time_series
    owner: Auction
    domain_of:
    - EnvironmentalMonitoringStation
    - ConstraintDuration
    - AttributeInstanceComponent
    - MarketDocument
    - Point
    - Reason
    - RegisteredResource
    - MarketParticipant
    - Domain
    - Quantity
    - Price
    - MarketObjectStatus
    - Period
    - FlowDirection
    - Unit
    - DateAndOrTime
    - Auction
    - MktPSRType
    - MarketEvaluationPoint
    range: TimeSeries
    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: Auction
    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: Auction
    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: Auction
    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: Auction
    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: Auction
    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: Auction
    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: Auction
    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: Auction
    domain_of:
    - IdentifiedObject
    range: ChangeSetMember
    required: false
class_uri: cim:Auction