swarm.analysis
Interface ActiveGraph

All Known Implementing Classes:
ActiveGraphImpl

public interface ActiveGraph
extends MessageProbe, MessageProbeS

Provides a continuous data feed between Swarm and the GUI.. An active graph object is the glue between a MessageProbe (for reading data) and a Graph GraphElement. ActiveGraphs are created and told where to get data from and send it to, and then are scheduled to actually do graphic functions. This class is used by EZGraph, and we expect to see less direct usage of it by end-users as more analysis tools (such as EZGraph) internalize its functionality.


Method Summary
 double getCurrentValue()
          Returns the value of the graph element..
 void step()
          Fires the probe, reads the value from the object, and draws it on the graph element.
 
Methods inherited from interface swarm.objectbase.MessageProbe
doubleDynamicCallOn, getArgCount, getArgName, getHideResult, getProbedMessage, isArgumentId, isResultId, longDynamicCallOn, objectDynamicCallOn, setArg$ToString, setArg$ToUnsigned, stringDynamicCallOn
 
Methods inherited from interface swarm.objectbase.MessageProbeS
setHideResult
 
Methods inherited from interface swarm.objectbase.Probe
clone, getProbedClass, getProbedType
 
Methods inherited from interface swarm.objectbase.SwarmObject
getCompleteProbeMap, getProbeForMessage, getProbeForVariable, getProbeMap
 
Methods inherited from interface swarm.objectbase.ProbeConfig
getObjectToNotify, setObjectToNotify
 
Methods inherited from interface swarm.defobj.Drop
drop
 
Methods inherited from interface swarm.defobj.DefinedObject
compare, describe, describeID, getDisplayName, getTypeName, getZone, perform, perform$with, perform$with$with, perform$with$with$with, respondsTo, setDisplayName, xfprint, xfprintid, xprint, xprintid
 
Methods inherited from interface swarm.defobj.GetName
getName
 

Method Detail

step

public void step()
Fires the probe, reads the value from the object, and draws it on the graph element. The X value is implicitly the current simulation time. Y is the value read.

getCurrentValue

public double getCurrentValue()
Returns the value of the graph element..