snl.ccss.jpowersystem
Interface Bus

All Known Implementing Classes:

AbstractACPFBus, AbstractBus, AbstractDCPFBus, AbstractPFBus

public interface Bus

This interface represents the base class for a Bus object that is to be part of a power system. It contains the methods required by a PowerSystem object when adding a new bus to the power system.

Author:

Bryan T. Richardson, Sandia National Laboratories

Method Summary

void	add(Branch branch) This method should at a minimum add the given Branch object to its list of attached branch objects.
void	add(BusDevice device) This method should at a minimum add the given BusDevice object to its list of attached bus device objects.
void	addTo(PowerSystem powerSystem) This method should at a minimum set a PowerSystem variable to the given power system.
java.util.List	getBranchList() This method should return a list of all Branch objects attached to this bus.
java.util.List	getBusDeviceList() This method should return a list of all BusDevice objects attached to this bus.
void	remove() This method should at a minimum remove each connected branch and bus device from itself and set the PowerSystem variable to null.
void	remove(Branch branch) This method should at a minimum remove the given Branch object from its list of attached branch objects.
void	remove(BusDevice device) This method should at a minimum remove the given BusDevice object from its list of attached bus device objects.

Method Detail

getBranchList

java.util.List getBranchList()

This method should return a list of all Branch objects attached to this bus.

Returns:

List of Branch objects

getBusDeviceList

java.util.List getBusDeviceList()

This method should return a list of all BusDevice objects attached to this bus.

Returns:

List of BusDevice objects

addTo

void addTo(PowerSystem powerSystem)

This method should at a minimum set a PowerSystem variable to the given power system.

Parameters:

powerSystem - PowerSystem object in which this bus exists

add

void add(Branch branch)

This method should at a minimum add the given Branch object to its list of attached branch objects.

Parameters:

branch - Branch object that is attached to this bus

add

void add(BusDevice device)

This method should at a minimum add the given BusDevice object to its list of attached bus device objects.

Parameters:

device - BusDevice object that is attached to this bus

remove

void remove()

This method should at a minimum remove each connected branch and bus device from itself and set the PowerSystem variable to null.

remove

void remove(Branch branch)

This method should at a minimum remove the given Branch object from its list of attached branch objects.

Parameters:

branch - Branch object to be removed from this bus

remove

void remove(BusDevice device)

This method should at a minimum remove the given BusDevice object from its list of attached bus device objects.

Parameters:

device - BusDevice object to be removed from this bus