gridiq.network
Class Bus

java.lang.Object
  gridiq.network.Bus

public class Bus
extends java.lang.Object

A bus in a power network. Bus attributes have been modelled from the PSAT data format. This class contains attributes of a bus as well as holds references to lines connecting this bus to other buses in the network.

Constructor Summary

Bus(int id)
Creates a bus with the given id.

Method Summary

void	addFromLine(Line line) Adds a line from this bus.
void	addSupply(Supply supply) Adds a supply attribute to this bus.
void	addToLine(Line line) Adds a line to this bus.
int	getArea() The area number of this bus.
Demand	getDemand() The demand attributes for this bus.
java.util.Set<Line>	getFromLines() Lines from this bus to other buses.
int	getId() The id of the bus.
java.lang.String	getName() The name of this bus.
Network	getNetwork() The network this bus belongs to.
PQLoad	getPQLoad() The PQ Load attributes of the bus.
PVGenerator	getPVGenerator() The PV Generator attributes of the bus.
int	getRegion() Gets the region number of this bus.
ShuntAdmittance	getShuntAdmittance() The Shunt Admittance attributes for this bus.
SlackGenerator	getSlackGenerator() The Slack Generator attributes of the bus.
java.util.Set<Supply>	getSupplies() The supply attributes for this bus.
java.util.Set<Line>	getToLines() The lines to this bus from other buses.
double	getVoltageAmplitudeInitialGuess() The Voltage amplitude initial guess to set for this bus in p.u.
double	getVoltageBase() The voltage base of this bus in kV.
double	getVoltagePhaseInitialGuess() The Voltage phase initial guess in rad.
void	setArea(int area) Sets the area number of this bus.
void	setDemand(Demand demand) Sets the demand attributes for this bus.
void	setId(int id) Sets the id of this bus.
void	setName(java.lang.String name) Sets the name of this bus.
void	setNetwork(Network network) Sets the network this bus belongs to.
void	setPQLoad(PQLoad pqLoad) Sets the PQ Load attributes of the bus.
void	setPVGenerator(PVGenerator pvGenerator) Sets the PV Generator attributes of the bus.
void	setRegion(int region) Sets the region number of this bus.
void	setShuntAdmittance(ShuntAdmittance shuntAdmittance) Sets the Shunt Admittance attributes for this bus.
void	setSlackGenerator(SlackGenerator slackGenerator) Sets the Slack Generator attributes of the bus.
void	setVoltageAmplitudeInitialGuess(double voltageAmplitudeInitialGuess) Sets the Voltage amplitude initial guess to set for this bus in p.u.
void	setVoltageBase(double voltageBase) Sets the voltage base to set for this bus in kV.
void	setVoltagePhaseInitialGuess(double voltagePhaseInitialGuess) Sets the Voltage phase initial guess in rad.
java.lang.String	toString() A String representation of this bus.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Bus

public Bus(int id)

Creates a bus with the given id.

Parameters:

id - the id of the bus.

Method Detail

toString

public java.lang.String toString()

A String representation of this bus.

Overrides:

toString in class java.lang.Object

getId

public int getId()

The id of the bus.

Returns:

the id of this bus.

setId

public void setId(int id)

Sets the id of this bus.

Parameters:

id - The id to set for this bus.

getVoltageBase

public double getVoltageBase()

The voltage base of this bus in kV.

Returns:

The voltage base of this bus in kV.

setVoltageBase

public void setVoltageBase(double voltageBase)

Sets the voltage base to set for this bus in kV.

Parameters:

voltageBase - The voltage base to set for this bus in kV.

getVoltageAmplitudeInitialGuess

public double getVoltageAmplitudeInitialGuess()

The Voltage amplitude initial guess to set for this bus in p.u.

Returns:

The voltage base to set for this bus in p.u.

setVoltageAmplitudeInitialGuess

public void setVoltageAmplitudeInitialGuess(double voltageAmplitudeInitialGuess)

Sets the Voltage amplitude initial guess to set for this bus in p.u.

Parameters:

voltageAmplitudeInitialGuess - the Voltage amplitude initial guess in p.u.

getVoltagePhaseInitialGuess

public double getVoltagePhaseInitialGuess()

The Voltage phase initial guess in rad.

Returns:

Voltage phase initial guess in rad.

setVoltagePhaseInitialGuess

public void setVoltagePhaseInitialGuess(double voltagePhaseInitialGuess)

Sets the Voltage phase initial guess in rad.

Parameters:

voltagePhaseInitialGuess - The Voltage phase initial guess in rad.

getArea

public int getArea()

The area number of this bus.

Returns:

The area number of this bus.

setArea

public void setArea(int area)

Sets the area number of this bus.

Parameters:

area - The area number.

getRegion

public int getRegion()

Gets the region number of this bus.

Returns:

the region number.

setRegion

public void setRegion(int region)

Sets the region number of this bus.

Parameters:

region - the region number.

getShuntAdmittance

public ShuntAdmittance getShuntAdmittance()

The Shunt Admittance attributes for this bus.

Returns:

The Shunt Admittance attributes for this bus.

setShuntAdmittance

public void setShuntAdmittance(ShuntAdmittance shuntAdmittance)

Sets the Shunt Admittance attributes for this bus.

Parameters:

shuntAdmittance - The Shunt Admittance attributes.

getDemand

public Demand getDemand()

The demand attributes for this bus.

Returns:

The demand attributes for this bus.

setDemand

public void setDemand(Demand demand)

Sets the demand attributes for this bus.

Parameters:

demand - The demand attributes for this bus.

getSupplies

public java.util.Set<Supply> getSupplies()

The supply attributes for this bus.

Returns:

The supply attributes for this bus.

addSupply

public void addSupply(Supply supply)

Adds a supply attribute to this bus.

Parameters:

supply - the supply attribute instance to add.

getPQLoad

public PQLoad getPQLoad()

The PQ Load attributes of the bus.

Returns:

The PQ Load attributes of the bus.

setPQLoad

public void setPQLoad(PQLoad pqLoad)

Sets the PQ Load attributes of the bus.

Parameters:

pqLoad - the PQ Load attributes.

getPVGenerator

public PVGenerator getPVGenerator()

The PV Generator attributes of the bus.

Returns:

The PV Generator attributes of the bus.

setPVGenerator

public void setPVGenerator(PVGenerator pvGenerator)

Sets the PV Generator attributes of the bus.

Parameters:

pvGenerator - The PV Generator attributes to set.

getSlackGenerator

public SlackGenerator getSlackGenerator()

The Slack Generator attributes of the bus.

Returns:

The Slack Generator attributes of the bus.

setSlackGenerator

public void setSlackGenerator(SlackGenerator slackGenerator)

Sets the Slack Generator attributes of the bus.

Parameters:

slackGenerator - The Slack Generator attributes to set.

getFromLines

public java.util.Set<Line> getFromLines()

Lines from this bus to other buses.

Returns:

The set of lines from this bus.

addFromLine

public void addFromLine(Line line)

Adds a line from this bus.

Parameters:

line - The line to add.

getToLines

public java.util.Set<Line> getToLines()

The lines to this bus from other buses.

Returns:

The set of lines to this bus.

addToLine

public void addToLine(Line line)

Adds a line to this bus.

Parameters:

line - The line to add.

getName

public java.lang.String getName()

The name of this bus.

Returns:

The name of this bus.

setName

public void setName(java.lang.String name)

Sets the name of this bus.

Parameters:

name -

getNetwork

public Network getNetwork()

The network this bus belongs to.

Returns:

The network this bus belongs to.

setNetwork

public void setNetwork(Network network)

Sets the network this bus belongs to. Adds this bus to the network to create the two-way relationship.

Parameters:

network - The network to set.