com.interpss.core.net

Interface Branch

All Superinterfaces:

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

All Known Subinterfaces:

Aclf3WBranch, AclfBranch, Acsc3WBranch, AcscBranch, Branch3W, DcBranch, DistBranch, DStab3WBranch, DStabBranch, HvdcLine2T<TBus>, HvdcLine2TLCC<TBus>, HvdcLine2TVSC<TBus>, HvdcLine2TVSCDyn, HvdcLine2TVSCDynPlus, OpfBranch, SEBranch, Static3PBranch

All Known Implementing Classes:

Aclf3WBranchImpl, AclfBranchImpl, Acsc3WBranchImpl, AcscBranchImpl, Branch3WImpl, BranchImpl, DcBranchImpl, DistBranchImpl, DStab3WBranchImpl, DStabBranchImpl, HvdcLine2TImpl, HvdcLine2TLCCImpl, HvdcLine2TVSCDynImpl, HvdcLine2TVSCImpl, OpfBranchImpl, SEBranchImpl, Static3PBranchImpl

public interface Branch
extends ExtensionElement

A representation of the model object 'Branch'. Branch class for representing a 2-terminal branch concept for power system simulation. The branch has two terminals, connecting to two buses.

The following features are supported:

• Circuit Number
• From Side Metered
• Original Branch Id
• To Bus
• From Bus
• Network

See Also:

NetPackage.getBranch()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCircuitNumber() Returns the value of the 'Circuit Number' attribute.
Bus	getFromBus() Returns the value of the 'From Bus' reference.
java.lang.String	getFromBusId() get from Bus id (from branchId), the physical bus connected to the branch at the from side.
Network<?,?>	getNetwork() Returns the value of the 'Network' reference.
java.util.Optional<Bus>	getOppositeBus(Bus bus) get the opposite Bus of of input bus object
java.lang.String	getOriginalBranchId() Returns the value of the 'Original Branch Id' attribute.
Bus	getToBus() Returns the value of the 'To Bus' reference.
java.lang.String	getToBusId() get to Bus id ( (from branchId), the physical bus connected to the branch at the to side.
boolean	isFromBus(Bus bus) Check if the input Bus object is on the from side
boolean	isFromSideMetered() Returns the value of the 'From Side Metered' attribute.
boolean	isGroundBranch() Check if the branch is a ground branch (toBus=null)
boolean	isToBus(Bus bus) Check if the input Bus object is on the to side
boolean	reconnect(Bus bus, BranchBusSide side, boolean deactivateExistBus) Reconnect the branch to another bus.
void	setAttributes(java.lang.String name, java.lang.String desc, java.lang.String cirNumber) Set branch attributes: name, desc and circuit number.
void	setAttributes(java.lang.String name, java.lang.String desc, java.lang.String cirNumber, Area area, Zone zone) Set branch attributes: name, desc, circuit number, areaNo and zoneNo.
void	setCircuitNumber(java.lang.String value) Sets the value of the 'Circuit Number' attribute.
void	setFromBus(Bus value) Sets the value of the 'From Bus' reference.
void	setFromSideMetered(boolean value) Sets the value of the 'From Side Metered' attribute.
void	setNetwork(Network<?,?> value) Sets the value of the 'Network' reference.
void	setOriginalBranchId(java.lang.String value) Sets the value of the 'Original Branch Id' attribute.
void	setToBus(Bus value) Sets the value of the 'To Bus' reference.
java.lang.String	toString(double baseKva) Return a string representation of the branch states

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

getExtensionObject, setExtensionObject

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

getArea, getAreaId, getExtSeqNumber, getIntFlag, getOwner, getOwnerId, getSortNumber, getWeight, getZone, getZoneId, isBooleanFlag, setArea, setAreaId, setBooleanFlag, setExtSeqNumber, setIntFlag, setOwner, setOwnerId, setSortNumber, setWeight, setZone, setZoneId

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

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

readData, writeData

Method Detail

getNetwork

Network<?,?> getNetwork()

Returns the value of the 'Network' reference.

If the meaning of the 'Network' container reference isn't clear, there really should be more of a description here...

The containing parent Network object

Returns:

the value of the 'Network' reference.

See Also:

setNetwork(Network), NetPackage.getBranch_Network()

setNetwork

void setNetwork(Network<?,?> value)

Sets the value of the 'Network' reference.

Parameters:

value - the new value of the 'Network' reference.

See Also:

getNetwork()

getCircuitNumber

java.lang.String getCircuitNumber()

Returns the value of the 'Circuit Number' attribute. The default value is "1".

If the meaning of the 'Circuit Number' attribute isn't clear, there really should be more of a description here...

branch circuit number. It will be assigned automatically by the system starting from 1. The branch id is always in the format: fromBsuId->toBusId(circuitNumber)

Returns:

the value of the 'Circuit Number' attribute.

See Also:

setCircuitNumber(String), NetPackage.getBranch_CircuitNumber()

setCircuitNumber

void setCircuitNumber(java.lang.String value)

Sets the value of the 'Circuit Number' attribute.

Parameters:

value - the new value of the 'Circuit Number' attribute.

See Also:

getCircuitNumber()

isFromSideMetered

boolean isFromSideMetered()

Returns the value of the 'From Side Metered' attribute. The default value is "true".

If the meaning of the 'From Metered' attribute isn't clear, there really should be more of a description here...

Check if the branch is from side metered.

Returns:

the value of the 'From Side Metered' attribute.

See Also:

setFromSideMetered(boolean), NetPackage.getBranch_FromSideMetered()

setFromSideMetered

void setFromSideMetered(boolean value)

Sets the value of the 'From Side Metered' attribute.

Parameters:

value - the new value of the 'From Side Metered' attribute.

See Also:

isFromSideMetered()

getOriginalBranchId

java.lang.String getOriginalBranchId()

Returns the value of the 'Original Branch Id' attribute. The default value is "". The branch could be reconnected. The original branch id before the reconnect.

Returns:

the value of the 'Original Branch Id' attribute.

See Also:

setOriginalBranchId(String), NetPackage.getBranch_OriginalBranchId()

setOriginalBranchId

void setOriginalBranchId(java.lang.String value)

Sets the value of the 'Original Branch Id' attribute.

Parameters:

value - the new value of the 'Original Branch Id' attribute.

See Also:

getOriginalBranchId()

getFromBus

Bus getFromBus()

Returns the value of the 'From Bus' reference. It is bidirectional and its opposite is 'From Branch List'.

If the meaning of the 'From Bus' reference isn't clear, there really should be more of a description here...

Reference to the from side bus object. Please note - using getFromBus() method, you might get the parent bus in the consolidated network situatio.

Returns:

the value of the 'From Bus' reference.

See Also:

setFromBus(Bus), NetPackage.getBranch_FromBus(), Bus.getFromBranchList()

setFromBus

void setFromBus(Bus value)

Sets the value of the 'From Bus' reference.

Parameters:

value - the new value of the 'From Bus' reference.

See Also:

getFromBus()

getFromBusId

java.lang.String getFromBusId()

get from Bus id (from branchId), the physical bus connected to the branch at the from side. The method should be only used to deal with the consolidated network situation.

getToBusId

java.lang.String getToBusId()

get to Bus id ( (from branchId), the physical bus connected to the branch at the to side. The method should be only used to deal with the consolidated network situation.

getOppositeBus

java.util.Optional<Bus> getOppositeBus(Bus bus)

get the opposite Bus of of input bus object

Parameters:

bus - bus object

isFromBus

boolean isFromBus(Bus bus)

Check if the input Bus object is on the from side

Parameters:

bus - bus object

isToBus

boolean isToBus(Bus bus)

Check if the input Bus object is on the to side

Parameters:

bus - bus object

getToBus

Bus getToBus()

Returns the value of the 'To Bus' reference. It is bidirectional and its opposite is 'To Branch List'.

If the meaning of the 'To Bus' reference isn't clear, there really should be more of a description here...

Reference to the to side bus object. Please note - using getToBus() method, you might get the parent bus in the consolidated network situatio.

Returns:

the value of the 'To Bus' reference.

See Also:

setToBus(Bus), NetPackage.getBranch_ToBus(), Bus.getToBranchList()

setToBus

void setToBus(Bus value)

Sets the value of the 'To Bus' reference.

Parameters:

value - the new value of the 'To Bus' reference.

See Also:

getToBus()

setAttributes

void setAttributes(java.lang.String name,
                   java.lang.String desc,
                   java.lang.String cirNumber)

Set branch attributes: name, desc and circuit number.

Parameters:

name - branch name, optional in terms of analysis purpose

desc - branch description, optional in terms of analysis

cirNumber - branch circuit number

setAttributes

void setAttributes(java.lang.String name,
                   java.lang.String desc,
                   java.lang.String cirNumber,
                   Area area,
                   Zone zone)

Set branch attributes: name, desc, circuit number, areaNo and zoneNo.

Parameters:

name - branch name

desc - branch description

cirNumber - branch circuit number

area - branch area

zone - branch zone

isGroundBranch

boolean isGroundBranch()

Check if the branch is a ground branch (toBus=null)

reconnect

boolean reconnect(Bus bus,
                  BranchBusSide side,
                  boolean deactivateExistBus)

Reconnect the branch to another bus. The branch id will be adjusted accordingly.

Parameters:

bus - bus object

side - branch bus side, FromSide or ToSide

deactivateExistBus - Flag to control if the existing or original bus should be deactivated.

toString

java.lang.String toString(double baseKva)

Return a string representation of the branch states

Parameters:

baseKva - System base kva