DRCL J-Sim API

drcl.inet.sensorsim
Class BatteryCoinCell

java.lang.Object
  extended bydrcl.DrclObj
      extended bydrcl.comp.Component
          extended bydrcl.inet.sensorsim.BatteryBase
              extended bydrcl.inet.sensorsim.BatteryCoinCell
All Implemented Interfaces:
java.lang.Cloneable, ObjectCloneable, ObjectDuplicable, java.io.Serializable

public class BatteryCoinCell
extends BatteryBase

This class implements a Coin Cell battery.

Version:
1.0, 12/19/2003
Author:
Ahmed Sobeih
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class drcl.comp.Component
Component.Locks
 
Field Summary
static double VOLTAGE
           
 
Fields inherited from class drcl.inet.sensorsim.BatteryBase
battery, batteryOut, CPU_MODEL, FORK_PORT, MAX_COMPONENT, RADIO_MODEL, SENSOR_MODEL
 
Fields inherited from class drcl.comp.Component
FLAG_COMPONENT_NOTIFICATION, FLAG_DEBUG_ENABLED, FLAG_DIRECT_OUTPUT_ENABLED, FLAG_ENABLED, FLAG_ERROR_ENABLED, FLAG_EVENT_ENABLED, FLAG_GARBAGE_DISPLAY_ENABLED, FLAG_GARBAGE_ENABLED, FLAG_PORT_NOTIFICATION, FLAG_STARTED, FLAG_STOPPED, FLAG_TRACE_ENABLED, FLAG_UNDEFINED_START, id, infoPort, locks, name, parent, PortGroup_DEFAULT_GROUP, PortGroup_EVENT, PortGroup_SERVICE, Root, Trace_DATA, Trace_SEND
 
Constructor Summary
BatteryCoinCell()
           
BatteryCoinCell(double energy)
           
 
Method Summary
 int changeCurrent(double cur, int componentID)
          Changes the current drained by a power consumer.
 double energy()
          Gets the energy.
 double energyPercent()
          Gets the percentage of the energy that has been spent so far.
 double energySpent()
          Gets the energy that has been spent so far.
 void initializeCoinCell()
          Initializes the current-capacity table.
 boolean isDead()
          Returns true if all of the energy has been consumed.
 int setEnergy(double newEnergyValue)
          Sets the energy of the battery.
 void updateEnergy()
          Calculates the new value of the energy.
 
Methods inherited from class drcl.inet.sensorsim.BatteryBase
initialize, initialize, setBatteryID
 
Methods inherited from class drcl.comp.Component
addComponent, addComponent, addEventPort, addEventPort, addForkPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addServerPort, addServerPort, cancelFork, connect, containsComponent, containsComponent, containsPort, debug, disconnectAll, disconnectAllPeers, disconnectAllPorts, drop, drop, duplicate, error, error, expose, exposeEventPorts, exposePort, exposePort, exposePort, exposePort, exposePort, findAvailable, findAvailable, findAvailable, fork, forkAt, getAllComponents, getAllPorts, getAllPorts, getAllWiresInside, getAllWiresInsideOut, getAllWiresOut, getComponent, getComponentFlag, getComponentFlag, getContract, getContractHT, getContractHT, getDebugFlagsInBinary, getDebugLevelNames, getID, getName, getParent, getPort, getPort, getRoot, getTime, iduplicate, info, isAncestorOf, isContainer, isDebugEnabled, isDebugEnabledAt, isDirectlyRelatedTo, isDirectOutputEnabled, isEnabled, isErrorNoticeEnabled, isEventExportEnabled, isGarbageDisplayEnabled, isGarbageEnabled, isPortRemovable, isStarted, isStopped, isTraceEnabled, lock, notify, notifyAll, operate, reboot, removeAll, removeAllComponents, removeAllPorts, removeAllPorts, removeComponent, removeComponent, removePort, removePort, removePort, reset, resume, run, sduplicate, send, sendAt, setComponentFlag, setComponentFlag, setDebugEnabled, setDebugEnabled, setDebugEnabledAt, setDebugEnabledAt, setDebugEnabledAt, setDirectOutputEnabled, setDirectOutputEnabled, setEnabled, setErrorNoticeEnabled, setErrorNoticeEnabled, setEventExportEnabled, setEventExportEnabled, setExecutionBoundary, setGarbageDisplayEnabled, setGarbageDisplayEnabled, setGarbageEnabled, setGarbageEnabled, setID, setID, setName, setPort, setPort, setTraceEnabled, setTraceEnabled, sleepFor, sleepUntil, stop, toString, unexpose, unlock, useLocalForkManager, useLocalForkManager, wait
 
Methods inherited from class drcl.DrclObj
clone
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

VOLTAGE

public static final double VOLTAGE
See Also:
Constant Field Values
Constructor Detail

BatteryCoinCell

public BatteryCoinCell()

BatteryCoinCell

public BatteryCoinCell(double energy)
Method Detail

initializeCoinCell

public void initializeCoinCell()
Initializes the current-capacity table.


updateEnergy

public void updateEnergy()
Calculates the new value of the energy.


energy

public double energy()
Gets the energy.

Overrides:
energy in class BatteryBase

energyPercent

public double energyPercent()
Gets the percentage of the energy that has been spent so far.

Overrides:
energyPercent in class BatteryBase

energySpent

public double energySpent()
Gets the energy that has been spent so far.

Overrides:
energySpent in class BatteryBase

isDead

public boolean isDead()
Returns true if all of the energy has been consumed.

Overrides:
isDead in class BatteryBase

changeCurrent

public int changeCurrent(double cur,
                         int componentID)
Changes the current drained by a power consumer.

Overrides:
changeCurrent in class BatteryBase

setEnergy

public int setEnergy(double newEnergyValue)
Sets the energy of the battery.

Overrides:
setEnergy in class BatteryBase

DRCL J-Sim API

Copyright © 1998-2003 Distributed Real-time Computing Lab (DRCL). All Rights Reserved.     ~ To J-Sim Home ~