com.interpss.core.net

Interface Bus

All Superinterfaces:

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

All Known Subinterfaces:

AclfBus, AcscBus, BaseAclfBus<TGen,TLoad>, BaseAcscBus<TGen,TLoad>, BaseDStabBus<TGen,TLoad>, DcBus, DistBus, DStabBus, OpfBus, PVDcBus, SEBus, Static3PBus

All Known Implementing Classes:

AclfBusImpl, AcscBusImpl, BaseAclfBusImpl, BaseAcscBusImpl, BaseDStabBusImpl, BusImpl, DcBusImpl, DistBusImpl, DStabBusImpl, OpfBusImpl, PVDcBusImpl, SEBusImpl, Static3PBusImpl

public interface Bus
extends ExtensionElement

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
• Merge2 Bus Id
• Sub Area Flag
• Substation Id
• Substation
• Network
• To Branch List
• From Branch 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.
Branch	getConnectedBranch(java.lang.String branchId) Get the branch object physically connected to this bus identified by the branch id.
org.eclipse.emf.common.util.EList<Branch>	getFromBranchList() Returns the value of the 'From Branch List' reference list.
java.lang.String	getMerge2BusId() Returns the value of the 'Merge2 Bus Id' attribute.
Network<?,?>	getNetwork() Returns the value of the 'Network' reference.
int	getSubAreaFlag() Returns the value of the 'Sub Area Flag' attribute.
Substation	getSubstation() Returns the value of the 'Substation' reference.
java.lang.String	getSubstationId() Returns the value of the 'Substation Id' attribute.
org.eclipse.emf.common.util.EList<Branch>	getToBranchList() Returns the value of the 'To Branch List' reference list.
boolean	isIslandBus() Check if the Bus is an island bus.
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	setMerge2BusId(java.lang.String value) Sets the value of the 'Merge2 Bus Id' attribute.
void	setNetwork(Network<?,?> value) Sets the value of the 'Network' reference.
void	setSubAreaFlag(int value) Sets the value of the 'Sub Area Flag' attribute.
void	setSubstation(Substation value) Sets the value of the 'Substation' reference.
void	setSubstationId(java.lang.String value) Sets the value of the 'Substation Id' 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, 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

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

getMerge2BusId

java.lang.String getMerge2BusId()

Returns the value of the 'Merge2 Bus Id' attribute. The default value is "". The bus could be merged. Bus id this bus merged to.

Returns:

the value of the 'Merge2 Bus Id' attribute.

See Also:

setMerge2BusId(String), NetPackage.getBus_Merge2BusId()

setMerge2BusId

void setMerge2BusId(java.lang.String value)

Sets the value of the 'Merge2 Bus Id' attribute.

Parameters:

value - the new value of the 'Merge2 Bus Id' attribute.

See Also:

getMerge2BusId()

getSubAreaFlag

int getSubAreaFlag()

Returns the value of the 'Sub Area Flag' attribute. The default value is "-1". an internal int flag, used for SubArea related analysis implementation.

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

getSubstationId

java.lang.String getSubstationId()

Returns the value of the 'Substation Id' attribute. The default value is "". Substation id for serialization purpose.

Returns:

the value of the 'Substation Id' attribute.

See Also:

setSubstationId(String), NetPackage.getBus_SubstationId()

setSubstationId

void setSubstationId(java.lang.String value)

Sets the value of the 'Substation Id' attribute.

Parameters:

value - the new value of the 'Substation Id' attribute.

See Also:

getSubstationId()

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

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

getSubstation

Substation getSubstation()

Returns the value of the 'Substation' reference. It is bidirectional and its opposite is 'Bus List'. substation attribute

Returns:

the value of the 'Substation' reference.

See Also:

setSubstation(Substation), NetPackage.getBus_Substation(), Substation.getBusList()

setSubstation

void setSubstation(Substation value)

Sets the value of the 'Substation' reference.

Parameters:

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

See Also:

getSubstation()

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.

getConnectedBranch

Branch getConnectedBranch(java.lang.String branchId)

Get the branch object physically connected to this bus identified by the branch id. Return null if no branch is found.

Parameters:

branchId - branch id

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

isIslandBus

boolean isIslandBus()

Check if the Bus is an island bus.