com.interpss.core.net

Interface Bus

All Superinterfaces:

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

All Known Subinterfaces:

AclfBus, AcscBus, BaseAclfBus<TGen,TLoad>, BaseAcscBus<TGen,TLoad>, BaseDStabBus<TGen,TLoad>, BaseOpfBus, BaseOpfGenBus, DclfOpfBus, DclfOpfGenBus, DistBus, DStabBus, Dynamic3PBus, OpfBus, OpfGenBus, Steady3PBus

All Known Implementing Classes:

AclfBusImpl, AcscBusImpl, BaseAclfBusImpl, BaseAcscBusImpl, BaseDStabBusImpl, BaseOpfBusImpl, BusImpl, DclfOpfBusImpl, DclfOpfGenBusImpl, DistBusImpl, DStabBusImpl, Dynamic3PBusImpl, OpfBusImpl, OpfGenBusImpl, Steady3PBusImpl

public interface Bus
extends ExtensionElement, IAdaptable, IBusSwitchBreakModel

A representation of the model object 'Bus'. Bus class for representing a Bus concept for power system simulation. A bus may contain multiple bus sections, which are stored in the busSecList.

The following features are supported:

• Base Voltage
• Sub Area Flag
• Sec No
• Parent
• Network
• To Branch List
• From Branch List
• Bus Sec List

See Also:

NetPackage.getBus()

Method Summary

Modifier and Type	Method and Description
double	getBaseVoltage() Returns the value of the 'Base Voltage' attribute.
java.util.List<Branch>	getBranchList() Get the branch list including fromBranchList + toBranchList.
org.eclipse.emf.common.util.EList<Bus>	getBusSecList() Returns the value of the 'Bus Sec List' reference list.
org.eclipse.emf.common.util.EList<Branch>	getFromBranchList() Returns the value of the 'From Branch List' reference list.
Network<?,?>	getNetwork() Returns the value of the 'Network' reference.
Bus	getParent() Returns the value of the 'Parent' reference.
int	getSecNo() Returns the value of the 'Sec No' attribute.
int	getSubAreaFlag() Returns the value of the 'Sub Area Flag' attribute.
org.eclipse.emf.common.util.EList<Branch>	getToBranchList() Returns the value of the 'To Branch List' reference list.
int	nActiveBranchConnected() Get number of active branches connected to the bus
int	nBranchConnected() Get number of branches connected to the bus
int	nBranchConnected(boolean visited) Get number of visted (if visited = true) or unvisited (if visited = false) branches connected to the bus
int	nNonGroundBranchConnected(boolean inclActiveOnly) Get number of non-grounded branches connected to the bus.
void	setAttributes(java.lang.String name, java.lang.String desc) Set bus attributes: name and desc.
void	setAttributes(java.lang.String name, java.lang.String desc, Area area, Zone zone) Set bus attributes: name, desc, area and zone.
void	setBaseVoltage(double value) Sets the value of the 'Base Voltage' attribute.
void	setBaseVoltage(double volt, Unit.UnitType unit) Set the bus base voltage in the specified unit
void	setNetwork(Network<?,?> value) Sets the value of the 'Network' reference.
void	setParent(Bus value) Sets the value of the 'Parent' reference.
void	setSecNo(int value) Sets the value of the 'Sec No' attribute.
void	setSubAreaFlag(int value) Sets the value of the 'Sub Area Flag' attribute.
java.lang.String	toString(double baseKva) return a string representation of the bus 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.IBusSwitchBreakModel

addSection, addSection, getConnectedPhysicalBranch, getConnectedPhysicalBranchList, getSection, isChildSection, isIslandBus, isParent, removeSection

Method Detail

getBaseVoltage

double getBaseVoltage()

Returns the value of the 'Base Voltage' attribute. The default value is "0.0".

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

Bus base voltage in Volt

Returns:

the value of the 'Base Voltage' attribute.

See Also:

setBaseVoltage(double), NetPackage.getBus_BaseVoltage()

setBaseVoltage

void setBaseVoltage(double value)

Sets the value of the 'Base Voltage' attribute.

Parameters:

value - the new value of the 'Base Voltage' attribute.

See Also:

getBaseVoltage()

getSubAreaFlag

int getSubAreaFlag()

Returns the value of the 'Sub Area Flag' attribute. The default value is "-1". Bus section number. secNo = -1 indicates the bus is a parent bus. secNo > 1 indicates the bus is a child node

Returns:

the value of the 'Sub Area Flag' attribute.

See Also:

setSubAreaFlag(int), NetPackage.getBus_SubAreaFlag()

setSubAreaFlag

void setSubAreaFlag(int value)

Sets the value of the 'Sub Area Flag' attribute.

Parameters:

value - the new value of the 'Sub Area Flag' attribute.

See Also:

getSubAreaFlag()

getSecNo

int getSecNo()

Returns the value of the 'Sec No' attribute. The default value is "0".

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

Bus section number. secNo = -1 indicates the bus is a parent bus. secNo > 1 indicates the bus is a child node

Returns:

the value of the 'Sec No' attribute.

See Also:

setSecNo(int), NetPackage.getBus_SecNo()

setSecNo

void setSecNo(int value)

Sets the value of the 'Sec No' attribute.

Parameters:

value - the new value of the 'Sec No' attribute.

See Also:

getSecNo()

getFromBranchList

org.eclipse.emf.common.util.EList<Branch> getFromBranchList()

Returns the value of the 'From Branch List' reference list. The list contents are of type Branch. It is bidirectional and its opposite is 'From Bus'.

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

reference list to branches, which are connected to the bus at the fromside

Returns:

the value of the 'From Branch List' reference list.

See Also:

NetPackage.getBus_FromBranchList(), Branch.getFromBus()

getBusSecList

org.eclipse.emf.common.util.EList<Bus> getBusSecList()

Returns the value of the 'Bus Sec List' reference list. The list contents are of type Bus. It is bidirectional and its opposite is 'Parent'.

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

containing list of child buses in the case of Bus Switch/Break Model implementation.

Returns:

the value of the 'Bus Sec List' reference list.

See Also:

NetPackage.getBus_BusSecList(), getParent()

getParent

Bus getParent()

Returns the value of the 'Parent' reference. It is bidirectional and its opposite is 'Bus Sec List'.

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

reference to its parent Bus object in the Bus Switch/Break Model implementation

Returns:

the value of the 'Parent' reference.

See Also:

setParent(Bus), NetPackage.getBus_Parent(), getBusSecList()

setParent

void setParent(Bus value)

Sets the value of the 'Parent' reference.

Parameters:

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

See Also:

getParent()

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

Parant containing network object

Returns:

the value of the 'Network' reference.

See Also:

setNetwork(Network), NetPackage.getBus_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()

getToBranchList

org.eclipse.emf.common.util.EList<Branch> getToBranchList()

Returns the value of the 'To Branch List' reference list. The list contents are of type Branch. It is bidirectional and its opposite is 'To Bus'.

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

reference list to branches, which are connected to the bus at the toside

Returns:

the value of the 'To Branch List' reference list.

See Also:

NetPackage.getBus_ToBranchList(), Branch.getToBus()

setAttributes

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

Set bus attributes: name and desc.

Parameters:

name - bus name

desc - bus description

setAttributes

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

Set bus attributes: name, desc, area and zone.

Parameters:

name - bus name

desc - bus description

area - bus area

zone - bus zone

nBranchConnected

int nBranchConnected()

Get number of branches connected to the bus

nBranchConnected

int nBranchConnected(boolean visited)

Get number of visted (if visited = true) or unvisited (if visited = false) branches connected to the bus

nActiveBranchConnected

int nActiveBranchConnected()

Get number of active branches connected to the bus

nNonGroundBranchConnected

int nNonGroundBranchConnected(boolean inclActiveOnly)

Get number of non-grounded branches connected to the bus. If inclActiveOny = true, only count active branches.

getBranchList

java.util.List<Branch> getBranchList()

Get the branch list including fromBranchList + toBranchList. This is a utility function.

toString

java.lang.String toString(double baseKva)

return a string representation of the bus states

setBaseVoltage

void setBaseVoltage(double volt,
                    Unit.UnitType unit)

Set the bus base voltage in the specified unit

Parameters:

volt - bus base voltage

unit - base voltage unit