Packages

final case class IdentifiedObject(Element: BasicElement = null, aliasName: String = null, description: String = null, mRID: String = null, name: String = null, DiagramObjects: List[String] = null, InstanceSet: String = null, Names: List[String] = null, PropertiesCIMDataObject: String = null, TargetingCIMDataObject: List[String] = null) extends Element with Product with Serializable

This is a root class to provide common identification for all classes needing identification and naming attributes.

Element

Reference to the superclass object.

aliasName

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. The 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.

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.

mRID

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. For 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.

name

The name is any free human readable and possibly non unique text naming the object.

DiagramObjects

DiagramObject The diagram objects that are associated with the domain object.

InstanceSet

InstanceSet Dataset containing the data objects.

Names

Name All names of this identified object.

PropertiesCIMDataObject

ChangeSetMember The single CIM data object in the appropriate dataset context.

TargetingCIMDataObject

ChangeSetMember Data objects registered.

Linear Supertypes
Element, Product, Equals, Cloneable, Cloneable, Row, Serializable, Serializable, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. IdentifiedObject
  2. Element
  3. Product
  4. Equals
  5. Cloneable
  6. Cloneable
  7. Row
  8. Serializable
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IdentifiedObject(Element: BasicElement = null, aliasName: String = null, description: String = null, mRID: String = null, name: String = null, DiagramObjects: List[String] = null, InstanceSet: String = null, Names: List[String] = null, PropertiesCIMDataObject: String = null, TargetingCIMDataObject: List[String] = null)

    Element

    Reference to the superclass object.

    aliasName

    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. The 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.

    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.

    mRID

    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. For 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.

    name

    The name is any free human readable and possibly non unique text naming the object.

    DiagramObjects

    DiagramObject The diagram objects that are associated with the domain object.

    InstanceSet

    InstanceSet Dataset containing the data objects.

    Names

    Name All names of this identified object.

    PropertiesCIMDataObject

    ChangeSetMember The single CIM data object in the appropriate dataset context.

    TargetingCIMDataObject

    ChangeSetMember Data objects registered.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val DiagramObjects: List[String]
  5. val Element: BasicElement
  6. val InstanceSet: String
  7. val Names: List[String]
  8. val PropertiesCIMDataObject: String
  9. val TargetingCIMDataObject: List[String]
  10. def about: Boolean

    Flag for rdf:about elements.

    Flag for rdf:about elements.

    returns

    true if this is an rdf:about element, false otherwise.

    Definition Classes
    Element
  11. val aliasName: String
  12. def anyNull: Boolean
    Definition Classes
    Row
  13. def apply(i: Int): Any
    Definition Classes
    Row
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. def baseclass: String

    This class name.

    This class name.

    returns

    the class name without the package prefixes

    Definition Classes
    Element
  16. val bitfields: Array[Int]

    Valid fields bitmap.

    Valid fields bitmap.

    One (1) in a bit position means that field was found in parsing, zero means it has an indeterminate value. Field order is specified by the fields array.

    For classes constructed manually, we initially fill this in with the worst case scenario. ToDo: this won't work for classes with more than 128 fields (so far none).

    Definition Classes
    Element
  17. def classes: Seq[String]

    This class and the hierarchical list of classes this class derives from.

    This class and the hierarchical list of classes this class derives from.

    returns

    the list of classes without the package prefixes.

    Definition Classes
    Element
  18. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  19. def copy(): Row

    Return a copy of this object as a Row.

    Return a copy of this object as a Row.

    Creates a clone of this object for use in Row manipulations.

    returns

    The copy of the object.

    Definition Classes
    IdentifiedObject → Row
  20. val description: String
  21. def emit_attribute(field: String, value: Any)(implicit clz: String, s: StringBuilder): Unit

    Emit one XML attribute.

    Emit one XML attribute.

    field

    The name of the field.

    value

    The value of the field.

    clz

    The class name (e.g. ACLineSegment) of this element

    s

    The builder to write into.

    Definition Classes
    Element
    Example:
    1. <cim:Location.CoordinateSystem rdf:resource="#wgs84"/>

  22. def emit_element(field: String, value: Any)(implicit clz: String, s: StringBuilder): Unit

    Emit one XML element.

    Emit one XML element.

    field

    The name of the field.

    value

    The value of the field.

    clz

    The class name (e.g. ACLineSegment) of this element

    s

    The builder to write into.

    Definition Classes
    Element
    Example:
    1. <cim:IdentifiedObject.name>WGS 84</cim:IdentifiedObject.name>

  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(o: Any): Boolean
    Definition Classes
    Row → AnyRef → Any
  25. def export: String

    Return a string containing this object as XML.

    Return a string containing this object as XML.

    returns

    The XML corresponding to this object.

    Definition Classes
    IdentifiedObjectElement
  26. def export_fields: String

    Return a string containing the fields of this object suitable for inclusion in an XML object.

    Return a string containing the fields of this object suitable for inclusion in an XML object.

    returns

    A string with the fields coded in XML

    Definition Classes
    IdentifiedObjectElement
  27. def fieldIndex(name: String): Int
    Definition Classes
    Row
  28. def get(i: Int): AnyRef

    Get the value of the field at index i.

    Get the value of the field at index i.

    i

    The index of the field desired.

    returns

    The value stored in the field, or null if none.

    Definition Classes
    Element → Row
  29. def getAs[T](fieldName: String): T
    Definition Classes
    Row
  30. def getAs[T](i: Int): T
    Definition Classes
    Row
  31. def getBoolean(i: Int): Boolean
    Definition Classes
    Row
  32. def getByte(i: Int): Byte
    Definition Classes
    Row
  33. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def getDate(i: Int): Date
    Definition Classes
    Row
  35. def getDecimal(i: Int): BigDecimal
    Definition Classes
    Row
  36. def getDouble(i: Int): Double
    Definition Classes
    Row
  37. def getFloat(i: Int): Float
    Definition Classes
    Row
  38. def getInstant(i: Int): Instant
    Definition Classes
    Row
  39. def getInt(i: Int): Int
    Definition Classes
    Row
  40. def getJavaMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  41. def getList[T](i: Int): List[T]
    Definition Classes
    Row
  42. def getLocalDate(i: Int): LocalDate
    Definition Classes
    Row
  43. def getLong(i: Int): Long
    Definition Classes
    Row
  44. def getMap[K, V](i: Int): Map[K, V]
    Definition Classes
    Row
  45. def getSeq[T](i: Int): Seq[T]
    Definition Classes
    Row
  46. def getShort(i: Int): Short
    Definition Classes
    Row
  47. def getString(i: Int): String
    Definition Classes
    Row
  48. def getStruct(i: Int): Row
    Definition Classes
    Row
  49. def getTimestamp(i: Int): Timestamp
    Definition Classes
    Row
  50. def getValuesMap[T](fieldNames: Seq[String]): Map[String, T]
    Definition Classes
    Row
  51. def hashCode(): Int
    Definition Classes
    Row → AnyRef → Any
  52. def id: String

    Return the unique ID for the object, the mRID for IdentifiedObject derived classes.

    Return the unique ID for the object, the mRID for IdentifiedObject derived classes.

    returns

    The object ID.

    Definition Classes
    Element
  53. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  54. def isNullAt(i: Int): Boolean
    Definition Classes
    Row
  55. def json: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  56. def length: Int

    The number of fields in the object definition.

    The number of fields in the object definition.

    returns

    The number of defined fields for use in Row manipulations.

    Definition Classes
    Element → Row
  57. val mRID: String
  58. def mask(position: Int): Boolean

    Is a field present predicate.

    Is a field present predicate.

    Determines if the field at the given position was encountered while parsing.

    position

    the field position in the fields array

    returns

    true if the field was parsed, false otherwise.

    Definition Classes
    Element
  59. def mkString(start: String, sep: String, end: String): String
    Definition Classes
    Row
  60. def mkString(sep: String): String
    Definition Classes
    Row
  61. def mkString: String
    Definition Classes
    Row
  62. val name: String
  63. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  64. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  65. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  66. def prettyJson: String
    Definition Classes
    Row
    Annotations
    @Unstable()
  67. def schema: StructType
    Definition Classes
    Row
  68. def size: Int
    Definition Classes
    Row
  69. def sup: Element

    Return the superclass object.

    Return the superclass object.

    returns

    The typed superclass nested object.

    Definition Classes
    IdentifiedObjectElement
  70. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  71. def toSeq: Seq[Any]
    Definition Classes
    Row
  72. def toString(): String
    Definition Classes
    Row → AnyRef → Any
  73. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  75. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Element

Inherited from Product

Inherited from Equals

Inherited from Cloneable

Inherited from Cloneable

Inherited from Row

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Hierarchy

Row

Serialization

Ungrouped