com.interpss.core.net

Interface Branch

All Superinterfaces:

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

All Known Subinterfaces:

Aclf3WBranch, AclfBranch, Acsc3WBranch, AcscBranch, BaseHvdcLine2TVSC<TBus>, BaseOpfBranch, Branch3W, DclfOpfBranch, DistBranch, DStab3WBranch, DStabBranch, Dynamic3PBranch, HvdcLine2T, HvdcLine2TCCC, HvdcLine2TVSC, HvdcLine2TVSCDyn, HvdcLine2TVSCDynPlus, OpfBranch, Steady3PBranch

All Known Implementing Classes:

Aclf3WBranchImpl, AclfBranchImpl, Acsc3WBranchImpl, AcscBranchImpl, BaseHvdcLine2TVSCImpl, BaseOpfBranchImpl, Branch3WImpl, BranchImpl, DclfOpfBranchImpl, DistBranchImpl, DStab3WBranchImpl, DStabBranchImpl, Dynamic3PBranchImpl, HvdcLine2TCCCImpl, HvdcLine2TImpl, HvdcLine2TVSCDynImpl, HvdcLine2TVSCImpl, OpfBranchImpl, Steady3PBranchImpl

public interface Branch
extends ExtensionElement, IAdaptable, IBranchSwitchBreakModel

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
• Child Branch
• From Side Metered
• Network
• To Bus
• From Bus

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.
Network<?,?>	getNetwork() Returns the value of the 'Network' reference.
Bus	getOppositeBus(Bus bus) get the opposite Bus of of input bus object
Bus	getToBus() Returns the value of the 'To Bus' reference.
boolean	isChildBranch() Returns the value of the 'Child Branch' attribute.
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
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	setChildBranch(boolean value) Sets the value of the 'Child Branch' attribute.
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	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, getIntFlag, getOwner, getSortNumber, getWeight, getZone, isBooleanFlag, setArea, setBooleanFlag, setIntFlag, setOwner, setSortNumber, setWeight, setZone

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

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

getAdapter, getAdapter

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

getConnectedPhysicalOppositeBus, getFromPhysicalBusConnected, getFromPhysicalBusId, getToPhysicalBusConnected, getToPhysicalBusId

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

isChildBranch

boolean isChildBranch()

Returns the value of the 'Child Branch' attribute. The default value is "false". attribute to indicate if the branch is a child branch in a consolidated network

Returns:

the value of the 'Child Branch' attribute.

See Also:

setChildBranch(boolean), NetPackage.getBranch_ChildBranch()

setChildBranch

void setChildBranch(boolean value)

Sets the value of the 'Child Branch' attribute.

Parameters:

value - the new value of the 'Child Branch' attribute.

See Also:

isChildBranch()

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

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

getOppositeBus

Bus getOppositeBus(Bus bus)
            throws InterpssException

get the opposite Bus of of input bus object

Parameters:

bus - bus object

Throws:

InterpssException

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)

toString

java.lang.String toString(double baseKva)

Return a string representation of the branch states

Parameters:

baseKva - System base kva