com.interpss.core.net

Interface INetBranchElement<TBus extends Bus,TBranch extends Branch>

All Superinterfaces:

org.eclipse.emf.ecore.EObject, 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, Network<TBus,TBranch>, OpfNetwork, Steady3PNetwork

All Known Implementing Classes:

AclfNetworkImpl, AcscNetworkImpl, BaseAclfNetworkImpl, BaseAcscNetworkImpl, BaseDStabNetworkImpl, BaseOpfNetworkImpl, DclfOpfNetworkImpl, DistNetworkImpl, DStabilityNetworkImpl, Dynamic3PNetworkImpl, NetworkImpl, OpfNetworkImpl, Steady3PNetworkImpl

public interface INetBranchElement<TBus extends Bus,TBranch extends Branch>
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'IBranch Element'. Network brabch related operation interface

See Also:

NetPackage.getINetBranchElement()

Method Summary

Modifier and Type	Method and Description
TBranch	addBranch(TBranch branch) Add the branch object into the network container.
TBranch	addBranch(TBranch branch, java.lang.String fromBusId, int fromBusSecNo, java.lang.String toBusId, int toBusSecNo) Add the branch object into the network container and connect to the from bus section and to bus section identified by the bus Id(s) and secNo.
TBranch	addBranch(TBranch branch, java.lang.String fromBusId, int fromBusSecNo, java.lang.String toBusId, int toBusSecNo, java.lang.String cirId) Add the branch object into the network container and connect to the from bus section and to bus section identified by the bus Id(s) and secNo.
TBranch	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.
TBranch	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).
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) Get the branch object identified by the from bus id and to bus id, assuming default branch circuit number is 1.
TBranch	getBranch(java.lang.String fromBusId, java.lang.String toBusId, boolean dirSensitive) Get the branch object identified by the from bus id and to bus id, assuming default branch circuit number is 1.
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.
int	getNoActiveBranch() return number of active branches in the network.
int	getNoBranch() return number of branches in the network.
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	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.

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

getNoBranch

int getNoBranch()

return number of branches in the network.

getNoActiveBranch

int getNoActiveBranch()

return number of active branches in the network.

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

getBranch

TBranch getBranch(java.lang.String fromBusId,
                  java.lang.String toBusId)

Get the branch object identified by the from bus id and to bus id, assuming default branch circuit number is 1. If branch not found, return null

Parameters:

fromBusId - from bus id

toBusId - to bus id

getBranch

TBranch getBranch(java.lang.String fromBusId,
                  java.lang.String toBusId,
                  boolean dirSensitive)

Get the branch object identified by the from bus id and to bus id, assuming default branch circuit number is 1. If branch not found, return null

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)

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

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

TBranch addBranch(TBranch branch)
           throws InterpssException

Add the branch object into the network container.

Parameters:

branch - the branch object to be added

Throws:

InterpssException

addBranch

TBranch addBranch(TBranch branch,
                  java.lang.String fromBusId,
                  java.lang.String toBusId)
           throws InterpssException

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

Throws:

InterpssException

addBranch

TBranch addBranch(TBranch branch,
                  java.lang.String fromBusId,
                  java.lang.String toBusId,
                  java.lang.String cirId)
           throws InterpssException

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

Throws:

InterpssException

addBranch

TBranch addBranch(TBranch branch,
                  java.lang.String fromBusId,
                  int fromBusSecNo,
                  java.lang.String toBusId,
                  int toBusSecNo)
           throws InterpssException

Add the branch object into the network container and connect to the from bus section and to bus section identified by the bus Id(s) and secNo. Set secNo = 0, if connecting to the bus itself.

Parameters:

branch - the branch object to be added

fromBusId - from bus id

fromBusSecNo - from bus section number

toBusId - to bus id

toBusSecNo - to bus section number

Throws:

InterpssException

addBranch

TBranch addBranch(TBranch branch,
                  java.lang.String fromBusId,
                  int fromBusSecNo,
                  java.lang.String toBusId,
                  int toBusSecNo,
                  java.lang.String cirId)
           throws InterpssException

Add the branch object into the network container and connect to the from bus section and to bus section identified by the bus Id(s) and secNo. Set secNo = 0, if connecting to the bus itself.

Parameters:

branch - the branch object to be added

fromBusId - from bus id

fromBusSecNo - from bus section number

toBusId - to bus id

toBusSecNo - to bus section number

cirId - branch circuit id

Throws:

InterpssException

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