snl.ccss.jpowersystem
Class AbstractBusDevice

java.lang.Object
  extended by snl.ccss.jpowersystem.AbstractBusDevice
All Implemented Interfaces:
BusDevice

public abstract class AbstractBusDevice
extends java.lang.Object
implements BusDevice

This is an abstract implementation of the BusDevice interface that can be extended by objects representing bus devices in a power sytem. It implements all the required methods in a minimal fashion so as to make it possible to add the object to a power system.

Author:
Bryan T. Richardson, Sandia National Laboratories

Constructor Summary
AbstractBusDevice()
           
 
Method Summary
 void addTo(Bus bus)
          This method connects this bus device to the given Bus object, with the given bus being set as the bus this device belongs to.
 void remove()
          This method disconnects this bus device from the known Bus object, the bus this device belongs to now being set to null.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractBusDevice

public AbstractBusDevice()
Method Detail

addTo

public void addTo(Bus bus)
This method connects this bus device to the given Bus object, with the given bus being set as the bus this device belongs to. It also calls the appropriate bus method to add this bus device to the bus.

Specified by:
addTo in interface BusDevice
Parameters:
bus - Bus object to attach this bus device to

remove

public void remove()
This method disconnects this bus device from the known Bus object, the bus this device belongs to now being set to null. It also calls the appropriate bus method to remove this bus device from the bus.

Specified by:
remove in interface BusDevice