Packages

case class CIMTopologyOptions(identify_islands: Boolean = false, force_retain_switches: State = Unforced, force_retain_fuses: State = Unforced, force_switch_separate_islands: State = Unforced, force_fuse_separate_islands: State = Unforced, default_switch_open_state: Boolean = false, debug: Boolean = false, storage: StorageLevel = StorageLevel.MEMORY_AND_DISK_SER) extends Product with Serializable

Topological processing options.

This class determines the behaviour of the CIMNetworkTopologyProcessor.

identify_islands

When true, topological islands are identified in addition to topological nodes. That is, TopologicalNode objects generated by the processor will have a valid TopologicalIsland attributes that reference generated TopologicalIsland objects.

force_retain_switches

Keep Switch and subclasses as two topological node elements irregardless of the retained attribute, or the open and normalOpen attributes. This is used for alternative scenario calculations. It allows the user to override the behaviour when the processor encounters a Switch or a Switch derived class (e.g. Disconnector), except Fuse and ProtectiveSwitch classes are not included by this flag. The default behaviour of Unforced will use the value of the retained attribute to identify a node boundary only if the attribute is present in the CIM file and the value is true. When set to ForceTrue the behaviour is equivalent to each Switch having a retained attribute with value true. When set to ForceFalse the behaviour is equivalent to each Switch having a retained attribute with value false.

force_retain_fuses

Keep Fuse, ProtectedSwitch and subclasses as two topological node elements irregardless of the retained attribute, or the open and normalOpen attributes. This is used for fuse specificity calculation. It allows the user to override the normal behaviour when a Fuse is encountered, which is to keep the two terminals as two topological nodes only if the retained attribute is present and true or the open attribute is present and has a value true or if open attribute is not present and the normalOpen attribute has a value true. This has the same effect for Fuse objects as force_retain_switches does for Switch objects.

force_switch_separate_islands

Extends the retain attribute to TopologicalIsland processing for Switch derived objects, except for Fuse and ProtectedSwitch objects. The default of Unforced uses the open or normalOpen attributes, if present, or the default_switch_open_state setting otherwise, to determine if a switch separates two islands. ForceTrue keeps the switch in two islands, irregardless of the switch state, while ForceFalse ensures the switch is in only one island.

force_fuse_separate_islands

Similar functionality as force_switch_separate_islands, but for Fuse objects.

default_switch_open_state

Allows changing the behaviour when the processor encounters a Switch that has neither an open attribute, nor normalOpen attribute. The default behaviour of false is the same as if open and normalOpen both specify false.

debug

If true additional tests are performed during topology processing:

  • unique VertexId for every ConnectivityNode mRID (checks the hash function)
  • all edges reference existing ConnectivityNode elements (checks for completeness)
  • no voltage transitions (checks that edges that are joined have the same BaseVoltage)
storage

The storage level for new and replaced CIM RDD.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CIMTopologyOptions
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CIMTopologyOptions(identify_islands: Boolean = false, force_retain_switches: State = Unforced, force_retain_fuses: State = Unforced, force_switch_separate_islands: State = Unforced, force_fuse_separate_islands: State = Unforced, default_switch_open_state: Boolean = false, debug: Boolean = false, storage: StorageLevel = StorageLevel.MEMORY_AND_DISK_SER)

    identify_islands

    When true, topological islands are identified in addition to topological nodes. That is, TopologicalNode objects generated by the processor will have a valid TopologicalIsland attributes that reference generated TopologicalIsland objects.

    force_retain_switches

    Keep Switch and subclasses as two topological node elements irregardless of the retained attribute, or the open and normalOpen attributes. This is used for alternative scenario calculations. It allows the user to override the behaviour when the processor encounters a Switch or a Switch derived class (e.g. Disconnector), except Fuse and ProtectiveSwitch classes are not included by this flag. The default behaviour of Unforced will use the value of the retained attribute to identify a node boundary only if the attribute is present in the CIM file and the value is true. When set to ForceTrue the behaviour is equivalent to each Switch having a retained attribute with value true. When set to ForceFalse the behaviour is equivalent to each Switch having a retained attribute with value false.

    force_retain_fuses

    Keep Fuse, ProtectedSwitch and subclasses as two topological node elements irregardless of the retained attribute, or the open and normalOpen attributes. This is used for fuse specificity calculation. It allows the user to override the normal behaviour when a Fuse is encountered, which is to keep the two terminals as two topological nodes only if the retained attribute is present and true or the open attribute is present and has a value true or if open attribute is not present and the normalOpen attribute has a value true. This has the same effect for Fuse objects as force_retain_switches does for Switch objects.

    force_switch_separate_islands

    Extends the retain attribute to TopologicalIsland processing for Switch derived objects, except for Fuse and ProtectedSwitch objects. The default of Unforced uses the open or normalOpen attributes, if present, or the default_switch_open_state setting otherwise, to determine if a switch separates two islands. ForceTrue keeps the switch in two islands, irregardless of the switch state, while ForceFalse ensures the switch is in only one island.

    force_fuse_separate_islands

    Similar functionality as force_switch_separate_islands, but for Fuse objects.

    default_switch_open_state

    Allows changing the behaviour when the processor encounters a Switch that has neither an open attribute, nor normalOpen attribute. The default behaviour of false is the same as if open and normalOpen both specify false.

    debug

    If true additional tests are performed during topology processing:

    • unique VertexId for every ConnectivityNode mRID (checks the hash function)
    • all edges reference existing ConnectivityNode elements (checks for completeness)
    • no voltage transitions (checks that edges that are joined have the same BaseVoltage)
    storage

    The storage level for new and replaced CIM RDD.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. val debug: Boolean
  7. val default_switch_open_state: Boolean
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. val force_fuse_separate_islands: State
  10. val force_retain_fuses: State
  11. val force_retain_switches: State
  12. val force_switch_separate_islands: State
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. val identify_islands: Boolean
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. val storage: StorageLevel
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. 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 Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped