DRCL J-Sim API

drcl.inet.sensorsim
Class BatteryBase

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

public abstract class BatteryBase
extends Component

Abstract base class for battery models.

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 java.lang.String battery
           
static java.lang.String batteryOut
           
static int CPU_MODEL
           
static java.lang.String FORK_PORT
           
static int MAX_COMPONENT
          Number of Maximum Components using the battery
static int RADIO_MODEL
           
static int 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
BatteryBase()
           
BatteryBase(double energy)
           
 
Method Summary
 int changeCurrent(double d, int i)
           
 double energy()
          Gets the energy
 double energyPercent()
           
 double energySpent()
          Gets the energy that has been spent so far
 void initialize()
           
 void initialize(double energy)
           
 boolean isDead()
           
 void setBatteryID(int id)
           
 int setEnergy(double energy)
          Sets the energy level of the battery
 
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

MAX_COMPONENT

public static final int MAX_COMPONENT
Number of Maximum Components using the battery

See Also:
Constant Field Values

batteryOut

public static final java.lang.String batteryOut
See Also:
Constant Field Values

battery

public static final java.lang.String battery
See Also:
Constant Field Values

FORK_PORT

public static final java.lang.String FORK_PORT
See Also:
Constant Field Values

RADIO_MODEL

public static final int RADIO_MODEL
See Also:
Constant Field Values

CPU_MODEL

public static final int CPU_MODEL
See Also:
Constant Field Values

SENSOR_MODEL

public static final int SENSOR_MODEL
See Also:
Constant Field Values
Constructor Detail

BatteryBase

public BatteryBase()

BatteryBase

public BatteryBase(double energy)
Method Detail

initialize

public void initialize()

initialize

public void initialize(double energy)

setBatteryID

public void setBatteryID(int id)

changeCurrent

public int changeCurrent(double d,
                         int i)

setEnergy

public int setEnergy(double energy)
Sets the energy level of the battery


energy

public double energy()
Gets the energy


energySpent

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


energyPercent

public double energyPercent()

isDead

public boolean isDead()

DRCL J-Sim API

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