Network

All Superinterfaces:

com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, IChildNet, NameTag, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

AclfNetwork, AcscNetwork, BaseAclfNetwork<TBus,TBranch>, BaseAcscNetwork<TBus,TBranch>, BaseDStabNetwork<TBus,TBra>, DcNetwork, DistNetwork, DStabilityNetwork, OpfNetwork, PlanningAclfNetwork, PVDcNetwork, SENetwork, Static3PNetwork

All Known Implementing Classes:

AclfNetworkImpl, AcscNetworkImpl, BaseAclfNetworkImpl, BaseAcscNetworkImpl, BaseDStabNetworkImpl, DcNetworkImpl, DistNetworkImpl, DStabilityNetworkImpl, NetworkImpl, OpfNetworkImpl, PlanningAclfNetworkImpl, PVDcNetworkImpl, SENetworkImpl, Static3PNetworkImpl
```
public interface Network<TBus extends Bus,TBranch extends Branch>
extends NameTag, IChildNet
```
A representation of the model object 'work'. The base network container class for storing buses and branches to format a power network.
The following features are supported:
See Also:

NetPackage.getNetwork()

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`accept(INetBVisitor<?,?> visitor)` accept a visitor to visit the Network object.
`void`	`addArea(Area area)` Add the area object into the Network, if it not exists in the network.
`boolean`	`addBranch(TBranch branch)` Add the branch object into the network container.
`boolean`	`addBranch(TBranch branch, java.lang.String fromBusId, java.lang.String toBusId)` Add the branch object into the network container and connect to the from bus and to bus identified by the Id(s) with default circuit number.
`boolean`	`addBranch(TBranch branch, java.lang.String fromBusId, java.lang.String toBusId, java.lang.String cirId)` Add the branch object into the network container and connect to the from bus and to bus identified by the Id(s).
`boolean`	`addBranch2Cache(TBranch branch)` Add the branch object into the cache HashMap.
`boolean`	`addBranch2Cache(TBranch branch, java.lang.String fromBusId, java.lang.String toBusId)` Add the branch object into the cache HashMap and connect to the from bus and to bus identified by the Id(s) with default circuit number.
`boolean`	`addBranch2Cache(TBranch branch, java.lang.String fromBusId, java.lang.String toBusId, java.lang.String cirId)` Add the branch object into the the cache HashMap and connect to the from bus and to bus identified by the Id(s).
`boolean`	`addBus(TBus bus)` Add the bus object into the network container.
`boolean`	`addBus2Cache(TBus bus)` Add the bus object into the cache HashMap.
`boolean`	`addGroundBranch(TBranch branch, java.lang.String busId)` Add a grpund branch object into the network container and connect to the bus with default circuit number.
`void`	`addOwner(Owner owner)` Add the owner object into the Network, if it not exists in the network.
`void`	`addSubstation(Substation substation)` Add the substation object into the Network, if it not exists in the network.
`java.util.Optional<TieLine>`	`addTieLine(java.lang.String meteredBusId, int meteredAreaNo, java.lang.String nonMeteredBusId, int nonMeteredAreaNo, java.lang.String cirNo)` Add a TieLine into the Network
`void`	`addZone(Zone zone)` Add the zone object into the Network, if it not exists in the network.
`void`	`arrangeBusNumber()` arrange bus sort number
`boolean`	`cachedBranches2Net()` transfer the cached branch objects into the network container.
`boolean`	`cachedBuses2Net()` transfer the cached bus objects into the network container.
`ISparseEqnInteger`	`formAdjacencyMatrix()` form the adjacency matrix, based on the bus.sortNumber
`Area`	`getArea(long areaNumber)` Get the area object by the area number
`Area`	`getArea(java.lang.String areaId)` Get the area object by the area name
`java.util.Map<java.lang.String,Area>`	`getAreaMap()` Returns the value of the 'Area Map' attribute.
`double`	`getBaseKva()` Returns the value of the 'Base Kva' attribute.
`double`	`getBaseMva()` get network base MVA
`TBranch`	`getBranch(java.lang.String branchId)` Get the branch object identified by the branch id.
`TBranch`	`getBranch(java.lang.String fromBusId, java.lang.String toBusId, java.lang.String circuitNumber)` Get the branch object identified by the from bus id, to bus id and branch circuit number.
`TBranch`	`getBranch(java.lang.String fromBusId, java.lang.String toBusId, java.lang.String circuitNumber, boolean dirSensitive)` Get the branch object identified by the from bus id, to bus id and branch circuit number.
`java.util.List<Branch>`	`getBranches(java.lang.String fromBusId, java.lang.String toBusId)` Get the branch object identified by the from bus id and to bus id.
`java.util.List<Branch>`	`getBranches(java.lang.String fromBusId, java.lang.String toBusId, boolean dirSensitive)` Get the branch object(s) identified by the from bus id and to bus id.
`org.eclipse.emf.common.util.EList<TBranch>`	`getBranchList()` Returns the value of the 'Branch List' reference list.
`TBus`	`getBus(int sortNumber)` Get the bus object identified by the id.
`TBus`	`getBus(java.lang.String id)` Get the bus object identified by the id.
`org.eclipse.emf.common.util.EList<TBus>`	`getBusList()` Returns the value of the 'Bus List' reference list.
`org.eclipse.emf.common.util.EList<ChildNetworkWrapper<?,?>>`	`getChildNetWrapperList()` Returns the value of the 'Child Net Wrapper List' containment reference list.
`java.util.Map<java.lang.String,java.lang.Object>`	`getExtraInfo()` Returns the value of the 'Extra Info' attribute.
`double`	`getFrequency()` Returns the value of the 'Frequency' attribute.
`int`	`getNoActiveBranch()` return number of active branches in the network.
`int`	`getNoActiveBranch(boolean inclChildNet)` return number of active branches in the network.
`int`	`getNoActiveBus()` Return total number of active buses in the net
`int`	`getNoActiveBus(boolean inclChildNet)` Return total number of active buses in the net
`int`	`getNoBranch()` return number of branches in the network.
`int`	`getNoBranch(boolean inclChildNet)` return number of branches in the network.
`int`	`getNoBus()` Return total number of buses in the net
`int`	`getNoBus(boolean inclChildNet)` Return total number of buses in the net
`OriginalDataFormat`	`getOriginalDataFormat()` Returns the value of the 'Original Data Format' attribute.
`Owner`	`getOwner(int number)` Get the owner object with the specified the owner number.
`Owner`	`getOwner(java.lang.String ownerId)` Get the owner object with the specified the id.
`java.util.Map<java.lang.String,Owner>`	`getOwnerMap()` Returns the value of the 'Owner Map' attribute.
`java.lang.String`	`getRefBusId()` Get the ref bus id.
`java.util.Set<java.lang.String>`	`getRefBusIdSet()` Returns the value of the 'Ref Bus Id Set' attribute.
`RefBusType`	`getRefBusType()` Returns the value of the 'Ref Bus Type' attribute.
`Substation`	`getSubstation(java.lang.String substationName)` Get the substation object by substation name
`java.util.Map<java.lang.String,Substation>`	`getSubstationMap()` Returns the value of the 'Substation Map' attribute.
`java.util.Map<java.lang.String,Substation>`	`getSubstationMap(boolean inclChildNet)` Get the substation object by substation name
`org.eclipse.emf.common.util.EList<TieLine>`	`getTieLineList()` Returns the value of the 'Tie Line List' containment reference list.
`java.time.LocalDateTime`	`getTimeStamp()` Returns the value of the 'Time Stamp' attribute.
`Zone`	`getZone(long zoneNo)` Get the zone object by zone number.
`Zone`	`getZone(java.lang.String zoneId)` Get the zone object by zone name
`java.util.Map<java.lang.String,Zone>`	`getZoneMap()` Returns the value of the 'Zone Map' attribute.
`boolean`	`hasBranch(java.lang.String fromBusId, java.lang.String toBusId)` Check if branch fromId->toBus with default circuit number exists in the network
`boolean`	`hasBranch(java.lang.String fromBusId, java.lang.String toBusId, java.lang.String cirId)` Check if branch fromId->toBus(cirId) exists in the network
`boolean`	`hasBus(java.lang.String busId)` Check if the network already contains a bus object with the busId
`<T> T`	`hzCopy()` Deprecated.
`boolean`	`isAllowGroundBranch()` Returns the value of the 'Allow Ground Branch' attribute.
`boolean`	`isBusNumberArranged()` Returns the value of the 'Bus Number Arranged' attribute.
`boolean`	`isBypassDataCheck()` Returns the value of the 'Bypass Data Check' attribute.
`boolean`	`isDataChecked()` Returns the value of the 'Data Checked' attribute.
`boolean`	`isOnlineModel()` Based on the original format, determine if the model is a online model.
`boolean`	`isRefBus(Bus bus)` check if the bus is a reference bus
`java.lang.String`	`net2String()` Transform all elements in the network to a string for print out purpose.
`void`	`rebuildLookupTable()` Rebuilt the network object lookup table, for example, after the network is recreated by de-serialization.
`boolean`	`removeBranch(java.lang.String branchId)` Remove the branch object with the branchId from the network container.
`boolean`	`removeBranch(java.lang.String fromBusId, java.lang.String toBusId, java.lang.String cirNumber)` Remove the branch object connected to the buses from the network container.
`boolean`	`removeBranch(TBus fromBus, TBus toBus, java.lang.String cirNumber)` Remove the branch object connected to the buses from the network container.
`boolean`	`removeBus(java.lang.String busId)` Remove the bus object identified by the busId from the network container.
`boolean`	`removeBus(TBus bus)` Remove the bus object from the network container.
`boolean`	`removeTieLine(java.lang.String tieLineId)` Remove the TieLine object from the Network container.
`boolean`	`replaceBus(java.lang.String busId, TBus bus)` replace the bus object (same busid) in the network container.
`void`	`setAllowGroundBranch(boolean value)` Sets the value of the '`Allow Ground Branch`' attribute.
`void`	`setBaseKva(double value)` Sets the value of the '`Base Kva`' attribute.
`void`	`setBusNumberArranged(boolean value)` Sets the value of the '`Bus Number Arranged`' attribute.
`void`	`setBypassDataCheck(boolean value)` Sets the value of the '`Bypass Data Check`' attribute.
`void`	`setDataChecked(boolean value)` Sets the value of the '`Data Checked`' attribute.
`void`	`setExtraInfo(java.util.Map<java.lang.String,java.lang.Object> value)` Sets the value of the '`Extra Info`' attribute.
`void`	`setFrequency(double value)` Sets the value of the '`Frequency`' attribute.
`void`	`setOriginalDataFormat(OriginalDataFormat value)` Sets the value of the '`Original Data Format`' attribute.
`void`	`setRefBusId(java.lang.String busId)` Set the ref bus id.
`void`	`setRefBusIdSet(java.util.Set<java.lang.String> value)` Sets the value of the '`Ref Bus Id Set`' attribute.
`void`	`setRefBusType(RefBusType value)` Sets the value of the '`Ref Bus Type`' attribute.
`void`	`setTimeStamp(java.time.LocalDateTime value)` Sets the value of the '`Time Stamp`' attribute.
`void`	`setToEmpty()` Set the network to empty, including remove all elements from the areaList, busList and branchList ...
`void`	`setVisitedStatus(boolean status)` Set bus and branch objects visited status
`void`	`updateBranchId(java.lang.String branchId)` After changing branch-bus connection relationship, it is used to update branchId.

Methods inherited from interface com.interpss.core.net.NameTag
checkData, checkData, getDesc, getId, getName, getNumber, getStatusChangeInfo, hzCopy, isActive, isStatus, jsonCopy, setDesc, setId, setName, setNumber, setStatus, setStatusChangeInfo

Methods inherited from interface com.hazelcast.nio.serialization.DataSerializable
readData, writeData

Methods inherited from interface com.interpss.core.net.IChildNet
getChildNetWrapper, hasChildNet

Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver

- Method Detail
  - getTimeStamp
```
java.time.LocalDateTime getTimeStamp()
```
    Returns the value of the 'Time Stamp' attribute. Time stamp, it is used for example in the Planning study
    
    Returns:
    
    the value of the 'Time Stamp' attribute.
    
    See Also:
    
    setTimeStamp(LocalDateTime), NetPackage.getNetwork_TimeStamp()
  - setTimeStamp
```
void setTimeStamp(java.time.LocalDateTime value)
```
    Sets the value of the 'Time Stamp' attribute.
    
    Parameters:
    
    value - the new value of the 'Time Stamp' attribute.
    
    See Also:
    
    getTimeStamp()
  - getBaseKva
```
double getBaseKva()
```
    Returns the value of the 'Base Kva' attribute. The default value is "100000".
    If the meaning of the 'Base Kva' attribute isn't clear, there really should be more of a description here...
    Base Kva in unit KVA.
    
    Returns:
    
    the value of the 'Base Kva' attribute.
    
    See Also:
    
    setBaseKva(double), NetPackage.getNetwork_BaseKva()
  - setBaseKva
```
void setBaseKva(double value)
```
    Sets the value of the 'Base Kva' attribute.
    
    Parameters:
    
    value - the new value of the 'Base Kva' attribute.
    
    See Also:
    
    getBaseKva()
  - getFrequency
```
double getFrequency()
```
    Returns the value of the 'Frequency' attribute. The default value is "50". System base frequency in Hz
    
    Returns:
    
    the value of the 'Frequency' attribute.
    
    See Also:
    
    setFrequency(double), NetPackage.getNetwork_Frequency()
  - setFrequency
```
void setFrequency(double value)
```
    Sets the value of the 'Frequency' attribute.
    
    Parameters:
    
    value - the new value of the 'Frequency' attribute.
    
    See Also:
    
    getFrequency()
  - isBusNumberArranged
```
boolean isBusNumberArranged()
```
    Returns the value of the 'Bus Number Arranged' attribute. The default value is "false".
    If the meaning of the 'Bus Number Arranged' attribute isn't clear, there really should be more of a description here...
    An indicator of bus number arrangement status
    
    Returns:
    
    the value of the 'Bus Number Arranged' attribute.
    
    See Also:
    
    setBusNumberArranged(boolean), NetPackage.getNetwork_BusNumberArranged()
  - setBusNumberArranged
```
void setBusNumberArranged(boolean value)
```
    Sets the value of the 'Bus Number Arranged' attribute.
    
    Parameters:
    
    value - the new value of the 'Bus Number Arranged' attribute.
    
    See Also:
    
    isBusNumberArranged()
  - isDataChecked
```
boolean isDataChecked()
```
    Returns the value of the 'Data Checked' attribute. The default value is "false".
    If the meaning of the 'Data Checked' attribute isn't clear, there really should be more of a description here...
    set to true after the data has been checked.
    
    Returns:
    
    the value of the 'Data Checked' attribute.
    
    See Also:
    
    setDataChecked(boolean), NetPackage.getNetwork_DataChecked()
  - setDataChecked
```
void setDataChecked(boolean value)
```
    Sets the value of the 'Data Checked' attribute.
    
    Parameters:
    
    value - the new value of the 'Data Checked' attribute.
    
    See Also:
    
    isDataChecked()
  - isBypassDataCheck
```
boolean isBypassDataCheck()
```
    Returns the value of the 'Bypass Data Check' attribute. The default value is "false".
    If the meaning of the 'Bypass Data Check' attribute isn't clear, there really should be more of a description here...
    set to true if bypass the data check is needed.
    
    Returns:
    
    the value of the 'Bypass Data Check' attribute.
    
    See Also:
    
    setBypassDataCheck(boolean), NetPackage.getNetwork_BypassDataCheck()
  - setBypassDataCheck
```
void setBypassDataCheck(boolean value)
```
    Sets the value of the 'Bypass Data Check' attribute.
    
    Parameters:
    
    value - the new value of the 'Bypass Data Check' attribute.
    
    See Also:
    
    isBypassDataCheck()
  - isAllowGroundBranch
```
boolean isAllowGroundBranch()
```
    Returns the value of the 'Allow Ground Branch' attribute. The default value is "false".
    If the meaning of the 'Allow Ground Branch' attribute isn't clear, there really should be more of a description here...
    An indicator for allowing branch branch, which connect to a bus and the ground.
    
    Returns:
    
    the value of the 'Allow Ground Branch' attribute.
    
    See Also:
    
    setAllowGroundBranch(boolean), NetPackage.getNetwork_AllowGroundBranch()
  - setAllowGroundBranch
```
void setAllowGroundBranch(boolean value)
```
    Sets the value of the 'Allow Ground Branch' attribute.
    
    Parameters:
    
    value - the new value of the 'Allow Ground Branch' attribute.
    
    See Also:
    
    isAllowGroundBranch()
  - getBusList
```
org.eclipse.emf.common.util.EList<TBus> getBusList()
```
    Returns the value of the 'Bus List' reference list.
    If the meaning of the 'Bus List' containment reference list isn't clear, there really should be more of a description here...
    bus list containing bus objects
    
    Returns:
    
    the value of the 'Bus List' reference list.
    
    See Also:
    
    NetPackage.getNetwork_BusList()
  - getBranchList
```
org.eclipse.emf.common.util.EList<TBranch> getBranchList()
```
    Returns the value of the 'Branch List' reference list.
    If the meaning of the 'Branch List' containment reference list isn't clear, there really should be more of a description here...
    branch list containing branch objects for 2W branches, which will be represented in the Y-matrix.
    
    Returns:
    
    the value of the 'Branch List' reference list.
    
    See Also:
    
    NetPackage.getNetwork_BranchList()
  - addArea
```
void addArea(Area area)
```
    Add the area object into the Network, if it not exists in the network.
  - addZone
```
void addZone(Zone zone)
```
    Add the zone object into the Network, if it not exists in the network.
  - addSubstation
```
void addSubstation(Substation substation)
```
    Add the substation object into the Network, if it not exists in the network.
  - addOwner
```
void addOwner(Owner owner)
```
    Add the owner object into the Network, if it not exists in the network.
  - getArea
```
Area getArea(long areaNumber)
```
    Get the area object by the area number
    
    Parameters:
    
    areaNumber - area number
  - getArea
```
Area getArea(java.lang.String areaId)
```
    Get the area object by the area name
    
    Parameters:
    
    areaId - area Id
  - getZone
```
Zone getZone(long zoneNo)
```
    Get the zone object by zone number.
    
    Parameters:
    
    zoneNo - zone number
  - getZone
```
Zone getZone(java.lang.String zoneId)
```
    Get the zone object by zone name
    
    Parameters:
    
    zoneId - zone id
  - getSubstation
```
Substation getSubstation(java.lang.String substationName)
```
    Get the substation object by substation name
    
    Parameters:
    
    substationName - substation name
  - getOwner
```
Owner getOwner(java.lang.String ownerId)
```
    Get the owner object with the specified the id.
    
    Parameters:
    
    ownerId - owner id
  - getOwner
```
Owner getOwner(int number)
```
    Get the owner object with the specified the owner number.
    
    Parameters:
    
    number - owner number
  - addTieLine
```
java.util.Optional<TieLine> addTieLine(java.lang.String meteredBusId,
                                       int meteredAreaNo,
                                       java.lang.String nonMeteredBusId,
                                       int nonMeteredAreaNo,
                                       java.lang.String cirNo)
```
    Add a TieLine into the Network
    
    Parameters:
    
    meteredBusId - metered bus id
    
    meteredAreaNo - metered area number
    
    nonMeteredBusId - non metered bus id
    
    nonMeteredAreaNo - non metered area number
    
    cirNo - tie line reference branch circuit id
  - removeTieLine
```
boolean removeTieLine(java.lang.String tieLineId)
```
    Remove the TieLine object from the Network container.
    
    Parameters:
    
    tieLineId - tie line id
  - setVisitedStatus
```
void setVisitedStatus(boolean status)
```
    Set bus and branch objects visited status
    
    Parameters:
    
    status - area number
  - getTieLineList
```
org.eclipse.emf.common.util.EList<TieLine> getTieLineList()
```
    Returns the value of the 'Tie Line List' containment reference list. The list contents are of type TieLine. It is bidirectional and its opposite is 'Network'.
    If the meaning of the 'Tie Line List' containment reference list isn't clear, there really should be more of a description here...
    Tieline list containing tieline objects
    
    Returns:
    
    the value of the 'Tie Line List' containment reference list.
    
    See Also:
    
    NetPackage.getNetwork_TieLineList(), TieLine.getNetwork()
  - getExtraInfo
```
java.util.Map<java.lang.String,java.lang.Object> getExtraInfo()
```
    Returns the value of the 'Extra Info' attribute. The default value is "". extra info map for the model extension purpose.
    
    Returns:
    
    the value of the 'Extra Info' attribute.
    
    See Also:
    
    setExtraInfo(Map), NetPackage.getNetwork_ExtraInfo()
  - setExtraInfo
```
void setExtraInfo(java.util.Map<java.lang.String,java.lang.Object> value)
```
    Sets the value of the 'Extra Info' attribute.
    
    Parameters:
    
    value - the new value of the 'Extra Info' attribute.
    
    See Also:
    
    getExtraInfo()
  - getChildNetWrapperList
```
org.eclipse.emf.common.util.EList<ChildNetworkWrapper<?,?>> getChildNetWrapperList()
```
    Returns the value of the 'Child Net Wrapper List' containment reference list. The list contents are of type ChildNetworkWrapper<?, ?>. It is bidirectional and its opposite is 'Parent Network'. child network list containing child network objects
    
    Returns:
    
    the value of the 'Child Net Wrapper List' containment reference list.
    
    See Also:
    
    NetPackage.getNetwork_ChildNetWrapperList(), ChildNetworkWrapper.getParentNetwork()
  - isOnlineModel
```
boolean isOnlineModel()
```
    Based on the original format, determine if the model is a online model.
  - accept
```
boolean accept(INetBVisitor<?,?> visitor)
```
    accept a visitor to visit the Network object. Usually, the visitor implements a network analysis/study algorithm.
  - getOriginalDataFormat
```
OriginalDataFormat getOriginalDataFormat()
```
    Returns the value of the 'Original Data Format' attribute. The literals are from the enumeration OriginalDataFormat.
    If the meaning of the 'Original Data Format' attribute isn't clear, there really should be more of a description here...
    Original data format
    
    Returns:
    
    the value of the 'Original Data Format' attribute.
    
    See Also:
    
    OriginalDataFormat, setOriginalDataFormat(OriginalDataFormat), NetPackage.getNetwork_OriginalDataFormat()
  - setOriginalDataFormat
```
void setOriginalDataFormat(OriginalDataFormat value)
```
    Sets the value of the 'Original Data Format' attribute.
    
    Parameters:
    
    value - the new value of the 'Original Data Format' attribute.
    
    See Also:
    
    OriginalDataFormat, getOriginalDataFormat()
  - getRefBusType
```
RefBusType getRefBusType()
```
    Returns the value of the 'Ref Bus Type' attribute. The default value is "Swing". The literals are from the enumeration RefBusType.
    If the meaning of the 'Ref Bus Type' attribute isn't clear, there really should be more of a description here...
    Reference bus type (Swing or user defined). User defined often is needed for the sensitivity analysis. When the type is userDefined, the refBusId is used for defined the RefBus.
    
    Returns:
    
    the value of the 'Ref Bus Type' attribute.
    
    See Also:
    
    RefBusType, setRefBusType(RefBusType), NetPackage.getNetwork_RefBusType()
  - setRefBusType
```
void setRefBusType(RefBusType value)
```
    Sets the value of the 'Ref Bus Type' attribute.
    
    Parameters:
    
    value - the new value of the 'Ref Bus Type' attribute.
    
    See Also:
    
    RefBusType, getRefBusType()
  - getRefBusIdSet
```
java.util.Set<java.lang.String> getRefBusIdSet()
```
    Returns the value of the 'Ref Bus Id Set' attribute. The default value is "". When reference bus is of the type UserDefined, this attribute defines reference bus id set.
    
    Returns:
    
    the value of the 'Ref Bus Id Set' attribute.
    
    See Also:
    
    setRefBusIdSet(Set), NetPackage.getNetwork_RefBusIdSet()
  - setRefBusIdSet
```
void setRefBusIdSet(java.util.Set<java.lang.String> value)
```
    Sets the value of the 'Ref Bus Id Set' attribute.
    
    Parameters:
    
    value - the new value of the 'Ref Bus Id Set' attribute.
    
    See Also:
    
    getRefBusIdSet()
  - getAreaMap
```
java.util.Map<java.lang.String,Area> getAreaMap()
```
    Returns the value of the 'Area Map' attribute. The default value is "". Area lookup table
    
    Returns:
    
    the value of the 'Area Map' attribute.
    
    See Also:
    
    NetPackage.getNetwork_AreaMap()
  - getZoneMap
```
java.util.Map<java.lang.String,Zone> getZoneMap()
```
    Returns the value of the 'Zone Map' attribute. The default value is "". Zone lookup table
    
    Returns:
    
    the value of the 'Zone Map' attribute.
    
    See Also:
    
    NetPackage.getNetwork_ZoneMap()
  - getOwnerMap
```
java.util.Map<java.lang.String,Owner> getOwnerMap()
```
    Returns the value of the 'Owner Map' attribute. The default value is "". Owner lookup table
    
    Returns:
    
    the value of the 'Owner Map' attribute.
    
    See Also:
    
    NetPackage.getNetwork_OwnerMap()
  - getSubstationMap
```
java.util.Map<java.lang.String,Substation> getSubstationMap()
```
    Returns the value of the 'Substation Map' attribute. The default value is "false". Substation lookup table
    
    Returns:
    
    the value of the 'Substation Map' attribute.
    
    See Also:
    
    NetPackage.getNetwork_SubstationMap()
  - getSubstationMap
```
java.util.Map<java.lang.String,Substation> getSubstationMap(boolean inclChildNet)
```
    Get the substation object by substation name
    
    Parameters:
    
    inclChildNet - flag to include the child network info
  - isRefBus
```
boolean isRefBus(Bus bus)
```
    check if the bus is a reference bus
  - getBaseMva
```
double getBaseMva()
```
    get network base MVA
  - setToEmpty
```
void setToEmpty()
```
    Set the network to empty, including remove all elements from the areaList, busList and branchList ...
  - net2String
```
java.lang.String net2String()
```
    Transform all elements in the network to a string for print out purpose.
  - getNoBus
```
int getNoBus()
```
    Return total number of buses in the net
  - getNoBus
```
int getNoBus(boolean inclChildNet)
```
    Return total number of buses in the net
    
    Parameters:
    
    inclChildNet - flag to include the child network info
  - getNoActiveBus
```
int getNoActiveBus()
```
    Return total number of active buses in the net
  - getNoActiveBus
```
int getNoActiveBus(boolean inclChildNet)
```
    Return total number of active buses in the net
    
    Parameters:
    
    inclChildNet - flag to include the child network info
  - addBus
```
boolean addBus(TBus bus)
```
    Add the bus object into the network container.
    
    Parameters:
    
    bus - bus object
  - addBus2Cache
```
boolean addBus2Cache(TBus bus)
```
    Add the bus object into the cache HashMap.
    
    Parameters:
    
    bus - bus object
  - cachedBuses2Net
```
boolean cachedBuses2Net()
```
    transfer the cached bus objects into the network container.
  - hasBus
```
boolean hasBus(java.lang.String busId)
```
    Check if the network already contains a bus object with the busId
    
    Parameters:
    
    busId - bus id
  - getRefBusId
```
java.lang.String getRefBusId()
```
    Get the ref bus id. It only applies to the scenarioes that there is only one ref bus in the entire network
  - setRefBusId
```
void setRefBusId(java.lang.String busId)
```
    Set the ref bus id. It only applies to the scenarioes that there is only one ref bus in the entire network
    
    Parameters:
    
    busId - from bus id
  - getBus
```
TBus getBus(java.lang.String id)
```
    Get the bus object identified by the id.
    
    Parameters:
    
    id - bus id
  - getBus
```
TBus getBus(int sortNumber)
```
    Get the bus object identified by the id.
    
    Parameters:
    
    sortNumber - bus sort number
  - replaceBus
```
boolean replaceBus(java.lang.String busId,
                   TBus bus)
```
    replace the bus object (same busid) in the network container. If there is any branch connected to the bus, the branch will be connected to the new object. Also, the bus lookup table will be also updated
    
    Parameters:
    
    busId - bus id
    
    bus - the bus object with same id to be removed
  - updateBranchId
```
void updateBranchId(java.lang.String branchId)
```
    After changing branch-bus connection relationship, it is used to update branchId. Also, the network branch lookup table will be also updated
    
    Parameters:
    
    branchId - branch id of the branch to be updated
  - removeBus
```
boolean removeBus(java.lang.String busId)
```
    Remove the bus object identified by the busId from the network container.
    
    Parameters:
    
    busId - bus id
  - removeBus
```
boolean removeBus(TBus bus)
```
    Remove the bus object from the network container.
    
    Parameters:
    
    bus - the bus object to be removed
  - getNoBranch
```
int getNoBranch()
```
    return number of branches in the network.
  - getNoBranch
```
int getNoBranch(boolean inclChildNet)
```
    return number of branches in the network.
    
    Parameters:
    
    inclChildNet - flag to include the child network info
  - getNoActiveBranch
```
int getNoActiveBranch()
```
    return number of active branches in the network.
  - getNoActiveBranch
```
int getNoActiveBranch(boolean inclChildNet)
```
    return number of active branches in the network.
    
    Parameters:
    
    inclChildNet - flag to include the child network info
  - hasBranch
```
boolean hasBranch(java.lang.String fromBusId,
                  java.lang.String toBusId)
```
    Check if branch fromId->toBus with default circuit number exists in the network
    
    Parameters:
    
    fromBusId - from bus id
    
    toBusId - to bus id
  - hasBranch
```
boolean hasBranch(java.lang.String fromBusId,
                  java.lang.String toBusId,
                  java.lang.String cirId)
```
    Check if branch fromId->toBus(cirId) exists in the network
    
    Parameters:
    
    fromBusId - from bus id
    
    toBusId - to bus id
    
    cirId - branch circuit id
  - getBranch
```
TBranch getBranch(java.lang.String branchId)
```
    Get the branch object identified by the branch id. If branch not found, first the fromId and toId is switched to find the branch again. Then if still not found, return null.
    
    Parameters:
    
    branchId - branch id
  - getBranches
```
java.util.List<Branch> getBranches(java.lang.String fromBusId,
                                   java.lang.String toBusId)
```
    Get the branch object identified by the from bus id and to bus id.
    
    Parameters:
    
    fromBusId - from bus id
    
    toBusId - to bus id
  - getBranch
```
TBranch getBranch(java.lang.String fromBusId,
                  java.lang.String toBusId,
                  java.lang.String circuitNumber)
```
    Get the branch object identified by the from bus id, to bus id and branch circuit number. If branch not found, return null
    
    Parameters:
    
    fromBusId - from bus id
    
    toBusId - to bus id
    
    circuitNumber - branch circuit number
  - getBranches
```
java.util.List<Branch> getBranches(java.lang.String fromBusId,
                                   java.lang.String toBusId,
                                   boolean dirSensitive)
```
    Get the branch object(s) identified by the from bus id and to bus id.
    
    Parameters:
    
    fromBusId - from bus id
    
    toBusId - to bus id
    
    dirSensitive - if set to true, branch search is direction sensitive
  - getBranch
```
TBranch getBranch(java.lang.String fromBusId,
                  java.lang.String toBusId,
                  java.lang.String circuitNumber,
                  boolean dirSensitive)
```
    Get the branch object identified by the from bus id, to bus id and branch circuit number. If branch not found, return null
    
    Parameters:
    
    fromBusId - from bus id
    
    toBusId - to bus id
    
    circuitNumber - branch circuit number
    
    dirSensitive - if set to true, branch search is direction sensitive
  - addBranch
```
boolean addBranch(TBranch branch)
```
    Add the branch object into the network container.
    
    Parameters:
    
    branch - the branch object to be added
  - addBranch2Cache
```
boolean addBranch2Cache(TBranch branch)
```
    Add the branch object into the cache HashMap.
    
    Parameters:
    
    branch - bus object
  - cachedBranches2Net
```
boolean cachedBranches2Net()
```
    transfer the cached branch objects into the network container.
  - addBranch
```
boolean addBranch(TBranch branch,
                  java.lang.String fromBusId,
                  java.lang.String toBusId)
```
    Add the branch object into the network container and connect to the from bus and to bus identified by the Id(s) with default circuit number. For a ground branch, set toBusId=null. The branch id and circuit number may be changed.
    
    Parameters:
    
    branch - the branch object to be added
    
    fromBusId - from bus id
    
    toBusId - to bus id
  - addGroundBranch
```
boolean addGroundBranch(TBranch branch,
                        java.lang.String busId)
```
    Add a grpund branch object into the network container and connect to the bus with default circuit number.
    
    Parameters:
    
    branch - the branch object to be added
    
    busId - from bus id
  - addBranch2Cache
```
boolean addBranch2Cache(TBranch branch,
                        java.lang.String fromBusId,
                        java.lang.String toBusId)
```
    Add the branch object into the cache HashMap and connect to the from bus and to bus identified by the Id(s) with default circuit number. For a ground branch, set toBusId=null. The branch id and circuit number may be changed.
    
    Parameters:
    
    branch - the branch object to be added
    
    fromBusId - from bus id
    
    toBusId - to bus id
  - addBranch
```
boolean addBranch(TBranch branch,
                  java.lang.String fromBusId,
                  java.lang.String toBusId,
                  java.lang.String cirId)
```
    Add the branch object into the network container and connect to the from bus and to bus identified by the Id(s). For a ground branch, set toBusId=null. The branch id and circuit number may be changed.
    
    Parameters:
    
    branch - the branch object to be added
    
    fromBusId - from bus id
    
    toBusId - to bus id
    
    cirId - branch circuit id
  - addBranch2Cache
```
boolean addBranch2Cache(TBranch branch,
                        java.lang.String fromBusId,
                        java.lang.String toBusId,
                        java.lang.String cirId)
```
    Add the branch object into the the cache HashMap and connect to the from bus and to bus identified by the Id(s). For a ground branch, set toBusId=null. The branch id and circuit number may be changed.
    
    Parameters:
    
    branch - the branch object to be added
    
    fromBusId - from bus id
    
    toBusId - to bus id
    
    cirId - branch circuit id
  - removeBranch
```
boolean removeBranch(java.lang.String fromBusId,
                     java.lang.String toBusId,
                     java.lang.String cirNumber)
```
    Remove the branch object connected to the buses from the network container.
    
    Parameters:
    
    fromBusId - from bud id
    
    toBusId - to bus id
    
    cirNumber - branch circuit number
  - removeBranch
```
boolean removeBranch(TBus fromBus,
                     TBus toBus,
                     java.lang.String cirNumber)
```
    Remove the branch object connected to the buses from the network container.
    
    Parameters:
    
    fromBus - from bus object
    
    toBus - to bus object
    
    cirNumber - branch circuit number
  - removeBranch
```
boolean removeBranch(java.lang.String branchId)
```
    Remove the branch object with the branchId from the network container.
    
    Parameters:
    
    branchId - branch id
  - arrangeBusNumber
```
void arrangeBusNumber()
```
    arrange bus sort number
  - rebuildLookupTable
```
void rebuildLookupTable()
```
    Rebuilt the network object lookup table, for example, after the network is recreated by de-serialization.
  - formAdjacencyMatrix
```
ISparseEqnInteger formAdjacencyMatrix()
```
    form the adjacency matrix, based on the bus.sortNumber
  - hzCopy
```
@Deprecated
<T> T hzCopy()
```
    Deprecated.
    
    make copy of all fields and refrences. Its actual implementation is done by the HZ read/writeData() methods.

Interface Network<TBus extends Bus,TBranch extends Branch>

Method Summary

Methods inherited from interface com.interpss.core.net.NameTag

Methods inherited from interface com.hazelcast.nio.serialization.DataSerializable

Methods inherited from interface com.interpss.core.net.IChildNet

Methods inherited from interface org.eclipse.emf.ecore.EObject

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

Method Detail

getTimeStamp

setTimeStamp

getBaseKva

setBaseKva

getFrequency

setFrequency

isBusNumberArranged

setBusNumberArranged

isDataChecked

setDataChecked

isBypassDataCheck

setBypassDataCheck

isAllowGroundBranch

setAllowGroundBranch

getBusList

getBranchList

addArea

addZone

addSubstation

addOwner

getArea

getArea

getZone

getZone

getSubstation

getOwner

getOwner

addTieLine

removeTieLine

setVisitedStatus

getTieLineList

getExtraInfo

setExtraInfo

getChildNetWrapperList

isOnlineModel

accept

getOriginalDataFormat

setOriginalDataFormat

getRefBusType

setRefBusType

getRefBusIdSet

setRefBusIdSet

getAreaMap

getZoneMap

getOwnerMap

getSubstationMap

getSubstationMap

isRefBus

getBaseMva

setToEmpty

net2String

getNoBus

getNoBus

getNoActiveBus

getNoActiveBus

addBus

addBus2Cache

cachedBuses2Net

hasBus

getRefBusId

setRefBusId

getBus

getBus

replaceBus

updateBranchId

removeBus

removeBus

getNoBranch

getNoBranch

getNoActiveBranch

getNoActiveBranch

hasBranch