snl.ccss.jpowersystem
Class PowerSystem

java.lang.Object
  extended by snl.ccss.jpowersystem.PowerSystem
Direct Known Subclasses:
AbstractPFPowerSystem

public class PowerSystem
extends java.lang.Object

This abstract class represents the main PowerSystem object. A power system object is similar to a "graph" or "network" object, in that it's nothing more than a collection of buses (nodes) and branches (edges) that make up the power system (network or graph). Additionally, it also contains bus devices, which are additional objects that commonly exist at substations in a power system (such as a generator, load, capacitor bank, etc).

Author:
Bryan T. Richardson, Sandia National Laboratories

Constructor Summary
PowerSystem()
          Default PowerSystem constructor.
 
Method Summary
 void add(Branch branch, Bus from, Bus to)
          This method is used to add a Branch object to the power system.
 void add(Bus bus)
          This method is used to add a Bus object to the power system.
 void add(BusDevice device, Bus bus)
          This method is used to add a BusDevice object to the power system.
 java.util.List getBranchList()
          Returns a complete list of branches that exist in the power system.
 java.util.List getBranchList(Bus bus)
          Returns a list of branches that are connected to the given bus.
 java.util.List getBusDeviceList()
          Returns a complete list of bus devices that exist in the power system.
 java.util.List getBusDeviceList(Bus bus)
          Returns a list of bus devices that are connected to the given bus.
 java.util.List getBusList()
          Returns a complete list of buses that exist in the power system.
 void move(Branch branch, Bus newFrom, Bus newTo)
          This method is used to move a Branch object around in a power system.
 void move(BusDevice device, Bus newBus)
          This method is used to move a BusDevice object around in a power system.
 void remove(Branch branch)
          This method is used to remove a Branch object from the power sytem.
 void remove(Bus bus)
          This method is used to remove a Bus object from the power sytem.
 void remove(BusDevice device)
          This method is used to remove a BusDevice object from the power sytem.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PowerSystem

public PowerSystem()
Default PowerSystem constructor.

Method Detail

getBusList

public java.util.List getBusList()
Returns a complete list of buses that exist in the power system.

Returns:
List containing all buses in power system

getBranchList

public java.util.List getBranchList()
Returns a complete list of branches that exist in the power system.

Returns:
List containing all branches in power system

getBranchList

public java.util.List getBranchList(Bus bus)
Returns a list of branches that are connected to the given bus.

Parameters:
bus - Bus object to query for connected branches
Returns:
List of branches connected to given bus

getBusDeviceList

public java.util.List getBusDeviceList()
Returns a complete list of bus devices that exist in the power system.

Returns:
List containing all bus devices in power system

getBusDeviceList

public java.util.List getBusDeviceList(Bus bus)
Returns a list of bus devices that are connected to the given bus.

Parameters:
bus - Bus object to query for connected bus devices
Returns:
List of bus devices connected to given bus

add

public void add(Bus bus)
This method is used to add a Bus object to the power system. It calls the appropriate bus method to add it to the system and also adds the bus to a list of all buses that currently exist in the system.

Parameters:
bus - Bus object to be added to the power system

add

public void add(Branch branch,
                Bus from,
                Bus to)
This method is used to add a Branch object to the power system. It calls the appropriate branch method to add it to the system and also adds the branch to a list of all branches that currently exist in the system.

Parameters:
branch - Branch object to be added to the power system
from - Bus object to attach one end of branch to
to - Bus object to attach other end of branch to

add

public void add(BusDevice device,
                Bus bus)
This method is used to add a BusDevice object to the power system. It calls the appropriate bus device method to add it to the system and also adds the bus device to a list of all bus devices that currently exist in the system.

Parameters:
device - BusDevice object to be added to the power system
bus - Bus object to attach bus device to

move

public void move(Branch branch,
                 Bus newFrom,
                 Bus newTo)
This method is used to move a Branch object around in a power system. It calls the appropriate branch method to remove it from its current endpoint bus objects, then calls the approprate branch method to attach it between the two given bus objects.

Parameters:
branch - Branch object to be moved
newFrom - New Bus object that will be one endpoint for branch
newTo - New Bus object that will be other endpoing for branch

move

public void move(BusDevice device,
                 Bus newBus)
This method is used to move a BusDevice object around in a power system. It calls the appropriate bus device method to remove it from its current bus object, then calls the appropriate bus device method to attach it to the given bus object.

Parameters:
device - BusDevice object to be moved
newBus - New Bus object that bus device will be connected to

remove

public void remove(Bus bus)
This method is used to remove a Bus object from the power sytem. It calls the appropriate bus method to remove it from the power system, then removes the bus from the list of buses that currently exist in the power system.

Parameters:
bus - Bus object to be removed from power system

remove

public void remove(Branch branch)
This method is used to remove a Branch object from the power sytem. It calls the appropriate branch method to remove it from the power system, then removes the branch from the list of buses that currently exist in the power system.

Parameters:
branch - Branch object to be removed from power system

remove

public void remove(BusDevice device)
This method is used to remove a BusDevice object from the power sytem. It calls the appropriate bus device method to remove it from the power system, then removes the bus device from the list of bus devices that currently exist in the power system.

Parameters:
device - BusDevice object to be removed from power system