Network

All Superinterfaces:

com.hazelcast.nio.serialization.DataSerializable, org.eclipse.emf.ecore.EObject, IAdaptable, IMultiNet, INetBranchElement<TBus,TBranch>, INetBusElement<TBus>, INetworkElement, NameTag, org.eclipse.emf.common.notify.Notifier

All Known Subinterfaces:

AclfNetwork, AcscNetwork, BaseAclfNetwork<TBus,TBranch>, BaseAcscNetwork<TBus,TBranch>, BaseDStabNetwork<TBus,TBra>, BaseOpfNetwork, DclfOpfNetwork, DistNetwork, DStab3PNetwork, DStabilityNetwork, Dynamic3PNetwork, OpfNetwork, Steady3PNetwork

All Known Implementing Classes:

AclfNetworkImpl, AcscNetworkImpl, BaseAclfNetworkImpl, BaseAcscNetworkImpl, BaseDStabNetworkImpl, BaseOpfNetworkImpl, DclfOpfNetworkImpl, DistNetworkImpl, DStabilityNetworkImpl, Dynamic3PNetworkImpl, NetworkImpl, OpfNetworkImpl, Steady3PNetworkImpl
```
public interface Network<TBus extends Bus,TBranch extends Branch>
extends NameTag, IAdaptable, INetworkElement, INetBusElement<TBus>, INetBranchElement<TBus,TBranch>, IMultiNet
```
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
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.
`void`	`addOwner(Owner owner)` Add the owner object into the Network, if it not exists in 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
`ISparseEqnInteger`	`formAdjacencyMatrix()` form the adjacency matrix, based on the bus.sortNumber
`org.eclipse.emf.common.util.EList<Area>`	`getAreaList()` Returns the value of the 'Area List' containment reference list.
`double`	`getBaseKva()` Returns the value of the 'Base Kva' attribute.
`double`	`getBaseMva()` get network base MVA
`org.eclipse.emf.common.util.EList<TBranch>`	`getBranchList()` Returns the value of the 'Branch List' reference list.
`org.eclipse.emf.common.util.EList<TBus>`	`getBusList()` Returns the value of the 'Bus List' reference list.
`org.eclipse.emf.common.util.EList<ChildNetwork<?,?>>`	`getChildNetList()` Returns the value of the 'Child Net List' containment reference list.
`double`	`getFrequency()` Returns the value of the 'Frequency' attribute.
`OriginalDataFormat`	`getOriginalDataFormat()` Returns the value of the 'Original Data Format' attribute.
`org.eclipse.emf.common.util.EList<Owner>`	`getOwnerList()` Returns the value of the 'Owner List' containment reference list.
`java.lang.String`	`getRefBusId()` Returns the value of the 'Ref Bus Id' attribute.
`RefBusType`	`getRefBusType()` Returns the value of the 'Ref Bus Type' attribute.
`org.eclipse.emf.common.util.EList<TieLine>`	`getTieLineList()` Returns the value of the 'Tie Line List' containment reference list.
`org.eclipse.emf.common.util.EList<Zone>`	`getZoneList()` Returns the value of the 'Zone List' containment reference list.
`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`	`isRefBus(Bus bus)` check if the bus is a reference bus
`boolean`	`isSwitchBreakModel()` Returns the value of the 'Switch Break Model' attribute.
`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.
`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`	`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 value)` Sets the value of the '`Ref Bus Id`' attribute.
`void`	`setRefBusType(RefBusType value)` Sets the value of the '`Ref Bus Type`' attribute.
`void`	`setSwitchBreakModel(boolean value)` Sets the value of the '`Switch Break Model`' attribute.
`void`	`setToEmpty()` Set the network to empty, including remove all elements from the areaList, busList and branchList ...

Methods inherited from interface com.interpss.core.net.NameTag
checkData, checkData, copy, copyRef, getDesc, getId, getName, getNumber, isActive, isStatus, setDesc, setId, setName, setNumber, setStatus

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

Methods inherited from interface com.interpss.core.net.IAdaptable
getAdapter, getAdapter

Methods inherited from interface com.interpss.core.net.INetworkElement
addTieLine, getArea, getOwner, getOwner, getZone, removeTieLine, setVisitedStatus

Methods inherited from interface com.interpss.core.net.INetBusElement
addBus, getBus, getBus, getBus, getNoActiveBus, getNoBus, hasBus, removeBus, removeBus, setBus

Methods inherited from interface com.interpss.core.net.INetBranchElement
addBranch, addBranch, addBranch, addBranch, addBranch, getBranch, getBranch, getBranch, getBranch, getBranch, getNoActiveBranch, getNoBranch, hasBranch, hasBranch, removeBranch, removeBranch, removeBranch

Methods inherited from interface com.interpss.core.net.IMultiNet
getChildNet, 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
  - 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()
  - isSwitchBreakModel
```
boolean isSwitchBreakModel()
```
    Returns the value of the 'Switch Break Model' attribute. The default value is "false".
    If the meaning of the 'Switch Break Model' attribute isn't clear, there really should be more of a description here...
    If true, allow to define bus section and dummy bus at branch for the switch/break model. The switch/break model is implemented using the bus section concept and child branch concept. It is independent of the zero Z branch concept. Zero Z branch could be used to create a switch/break network model.
    
    Returns:
    
    the value of the 'Switch Break Model' attribute.
    
    See Also:
    
    setSwitchBreakModel(boolean), NetPackage.getNetwork_SwitchBreakModel()
  - setSwitchBreakModel
```
void setSwitchBreakModel(boolean value)
```
    Sets the value of the 'Switch Break Model' attribute.
    
    Parameters:
    
    value - the new value of the 'Switch Break Model' attribute.
    
    See Also:
    
    isSwitchBreakModel()
  - 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()
  - getZoneList
```
org.eclipse.emf.common.util.EList<Zone> getZoneList()
```
    Returns the value of the 'Zone List' containment reference list. The list contents are of type Zone. It is bidirectional and its opposite is 'Network'.
    If the meaning of the 'Zone List' containment reference list isn't clear, there really should be more of a description here...
    zone list containing zone objects
    
    Returns:
    
    the value of the 'Zone List' containment reference list.
    
    See Also:
    
    NetPackage.getNetwork_ZoneList(), Zone.getNetwork()
  - 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()
  - getAreaList
```
org.eclipse.emf.common.util.EList<Area> getAreaList()
```
    Returns the value of the 'Area List' containment reference list. The list contents are of type Area. It is bidirectional and its opposite is 'Network'.
    If the meaning of the 'Area List' containment reference list isn't clear, there really should be more of a description here...
    area list containing area objects
    
    Returns:
    
    the value of the 'Area List' containment reference list.
    
    See Also:
    
    NetPackage.getNetwork_AreaList(), Area.getNetwork()
  - 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.
  - addOwner
```
void addOwner(Owner owner)
```
    Add the owner object into the Network, if it not exists in the network.
  - 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()
  - getOwnerList
```
org.eclipse.emf.common.util.EList<Owner> getOwnerList()
```
    Returns the value of the 'Owner List' containment reference list. The list contents are of type Owner. It is bidirectional and its opposite is 'Network'.
    If the meaning of the 'Owner List' containment reference list isn't clear, there really should be more of a description here...
    Owner list containing owner objects
    
    Returns:
    
    the value of the 'Owner List' containment reference list.
    
    See Also:
    
    NetPackage.getNetwork_OwnerList(), Owner.getNetwork()
  - getChildNetList
```
org.eclipse.emf.common.util.EList<ChildNetwork<?,?>> getChildNetList()
```
    Returns the value of the 'Child Net List' containment reference list. The list contents are of type ChildNetwork<?, ?>. It is bidirectional and its opposite is 'Parent Network'. child network list containing child network objects
    
    Returns:
    
    the value of the 'Child Net List' containment reference list.
    
    See Also:
    
    NetPackage.getNetwork_ChildNetList(), ChildNetwork.getParentNetwork()
  - 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.
    
    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()
  - getRefBusId
```
java.lang.String getRefBusId()
```
    Returns the value of the 'Ref Bus Id' attribute. The default value is "false".
    If the meaning of the 'Ref Bus Id' attribute isn't clear, there really should be more of a description here...
    When reference bus is user defined, this attribute defines reference bus id.
    
    Returns:
    
    the value of the 'Ref Bus Id' attribute.
    
    See Also:
    
    setRefBusId(String), NetPackage.getNetwork_RefBusId()
  - setRefBusId
```
void setRefBusId(java.lang.String value)
```
    Sets the value of the 'Ref Bus Id' attribute.
    
    Parameters:
    
    value - the new value of the 'Ref Bus Id' attribute.
    
    See Also:
    
    getRefBusId()
  - 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.
  - 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

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

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

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

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

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

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

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

Method Detail

getBaseKva

setBaseKva

getFrequency

setFrequency

isBusNumberArranged

setBusNumberArranged

isDataChecked

setDataChecked

isBypassDataCheck

setBypassDataCheck

isAllowGroundBranch

setAllowGroundBranch

isSwitchBreakModel

setSwitchBreakModel

getBusList

getZoneList

getBranchList

getAreaList

addArea

addZone

addOwner

getTieLineList

getOwnerList

getChildNetList

accept

getOriginalDataFormat

setOriginalDataFormat

getRefBusType

setRefBusType

getRefBusId

setRefBusId

isRefBus

getBaseMva

setToEmpty

net2String

arrangeBusNumber

rebuildLookupTable

formAdjacencyMatrix