swarm.objectbase
Interface SwarmObject

All Known Subinterfaces:
ActiveGraph, ActiveOutFile, ActivityControl, Averager, BernoulliDist, BooleanDistribution, C2TAUS1gen, C2TAUS2gen, C2TAUS3gen, C2TAUSgen, Ca2d, ControlPanel, ConwayLife2d, DblBuffer2d, DefaultProbeMap, Diffuse2d, Discrete2d, DoubleDistribution, Entropy, ExponentialDist, EZBin, EZDistribution, EZGraph, EZSequence, FunctionGraph, GammaDist, Grid2d, Int2dFiler, IntegerDistribution, LogNormalDist, MessageProbe, MT19937gen, Normal, NormalDist, NSelect, Object2dDisplay, PMMLCG1gen, PMMLCGgen, ProbabilityDistribution, Probe, ProbeDisplayManager, ProbeMap, PSWBgen, QSort, RandomBitDist, SimpleRandomGenerator, UName, UniformDoubleDist, UniformIntegerDist, UniformUnsignedDist, UnsignedDistribution, Value2dDisplay, VarProbe
All Known Implementing Classes:
ActivityControlImpl, ProbeMapImpl, SwarmObjectImpl, UNameImpl, NSelectImpl, QSortImpl, ProbeDisplayManagerImpl, ControlPanelImpl, Int2dFilerImpl, Discrete2dImpl, Value2dDisplayImpl, Object2dDisplayImpl, EZBinImpl, EZSequenceImpl, FunctionGraphImpl, EZGraphImpl

public abstract interface SwarmObject
extends CreateS, Create, DropS, Drop

A superclass of most objects in a Swarm simulation that provides support for probing.. A SwarmObject is an object that is intended to be a member of a Swarm. It's behavior will be perpetuated by messages sent from the schedule of events defined in the context of Swarm object. The SwarmObject is where the models of all the agents of a simulation will reside. Hence, most of the burden on defining the messages that can be sent to any agent lies with the user. SwarmObject inherits its basic functionality from the Create and Drop object types defined in the defobj library.


Method Summary
 ProbeMapImpl getCompleteProbeMap()
          The getCompleteProbeMap method returns a newly created CompleteProbeMap for an object.
 MessageProbeImpl getProbeForMessage(String aMessage)
          The getProbeForMessage: method returns the MessageProbe indexed in the ProbeMap by the string aMessage.
 VarProbeImpl getProbeForVariable(String aVariable)
          The getProbeForVariable: method returns the VarProbe indexed in the ProbeMap by the string aVariable.
 ProbeMapImpl getProbeMap()
          The getProbeMap method returns a pointer to the ProbeMap for the object if there has been one creaded for that object's class.
 
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
 

Method Detail

getProbeMap

public ProbeMapImpl getProbeMap()
The getProbeMap method returns a pointer to the ProbeMap for the object if there has been one creaded for that object's class. If it hasn't been created, then it creates a default ProbeMap.

getCompleteProbeMap

public ProbeMapImpl getCompleteProbeMap()
The getCompleteProbeMap method returns a newly created CompleteProbeMap for an object.

getProbeForVariable

public VarProbeImpl getProbeForVariable(String aVariable)
The getProbeForVariable: method returns the VarProbe indexed in the ProbeMap by the string aVariable.

getProbeForMessage

public MessageProbeImpl getProbeForMessage(String aMessage)
The getProbeForMessage: method returns the MessageProbe indexed in the ProbeMap by the string aMessage.