Uses of Interface
com.speckled.specksim.Speck

Packages that use Speck

com.speckled.specksim	The main classes/interfaces of SpeckSim.
com.speckled.specksim.comm	Controls communication characteristics
com.speckled.specksim.imp.comm	Communication implementations
com.speckled.specksim.imp.env	Environment implementations
com.speckled.specksim.imp.motion	Movement model implementations.
com.speckled.specksim.imp.shells	MessageShell implementations.
com.speckled.specksim.imp.specks	Speck implementations.
com.speckled.specksim.listener	Interfaces for monitoring the behaviour of a simulator.

Uses of Speck in com.speckled.specksim

Fields in com.speckled.specksim declared as Speck

Speck

SimulationEvent.owner The owner of this event.

Methods in com.speckled.specksim that return Speck

static Speck

SpeckFactory.buildSpeck(java.lang.String name) Builds a Speck of a given type

Methods in com.speckled.specksim that return types with arguments of type Speck

java.util.Iterator<Speck>	SpeckSim.getSpecks() Gets an iterator over all the specks.
java.util.Iterator<Speck>	SpeckSim.getSpecks(java.lang.String name) Gets an iterator over all the specks of a given flavour.

Methods in com.speckled.specksim with parameters of type Speck

void	SpeckSim.addSpeck(Speck speck) Adds a speck to the simulator
int	SpeckSim.findSpeckIndex(Speck speck) Finds the index of a given speck in the master list of specks
SpeckPosition	MovementModel.getSpeckOrientation(Speck speck, float time) Works out the position of a given speck at a given time.
Vector3d	MovementModel.getSpeckVelocity(Speck speck, float time) Works out the velocity of a given speck at a given time
void	SpeckCapability.initiateBroadcast(Speck speck, Message m, MessageShell shell, MACProtocol mac) Initiates a broadcast
void	SpeckSim.initiateBroadcast(Speck speck, Message m, MessageShell shell, MACProtocol mac)
void	SpeckCapability.initiateBroadcast(Speck speck, MessageProducer mp, MessageShell shell, MACProtocol mac) Initiates a broadcast.
void	SpeckSim.initiateBroadcast(Speck speck, MessageProducer mp, MessageShell shell, MACProtocol mac)
void	SpeckCapability.removeOwnedEvents(Speck owner) Remove all events with a particular Speck as an owner
void	SpeckSim.removeOwnedEvents(Speck owner)
void	MovementModel.removeSpeck(Speck speck) Called when a speck is removed from the simulator.
void	SpeckSim.removeSpeck(Speck speck) Removes a speck from the simulator
void	Speck.shellEncountered(Speck sender, MessageShell shell, Message message) Called when the simulator determines that this speck lies within the bounds of a transmission.

Constructors in com.speckled.specksim with parameters of type Speck

SimulationEvent(Speck owner)
Constructs a new Event.

Uses of Speck in com.speckled.specksim.comm

Methods in com.speckled.specksim.comm with parameters of type Speck

float	CommunicationModel.broadcast(Speck speck, Message m, MessageShell shell) Simulate a broadcast
boolean	CommunicationModel.carrierSense(Speck speck, int channel) Detects if a speck is currently affected by a transmission
boolean	MessageShell.hit(Speck sender, SpeckPosition senderOrientation, Speck target, SpeckPosition targetOrientation) Checks to see if the sender can reach the target.
void	CommunicationModel.initiateBroadcast(Speck speck, Message m, MessageShell shell, MACProtocol mac) Called by specks when they want to broadcast a message
void	CommunicationModel.initiateBroadcast(Speck speck, MessageProducer mp, MessageShell shell, MACProtocol mac) Called by specks when they want to broadcast a message.
void	MACProtocol.initiateBroadcast(SpeckSim simulator, CommunicationModel commsModel, Speck speck, MessageShell shell, MessageProducer m) Called to initiate a broadcast.
float	CommunicationModel.isBroadcasting(Speck speck, int channel) Determines if a speck is currently broadcasting on a given channel

Uses of Speck in com.speckled.specksim.imp.comm

Fields in com.speckled.specksim.imp.comm declared as Speck

protected Speck

AbstractMac.speck The transmitting speck

Methods in com.speckled.specksim.imp.comm that return types with arguments of type Speck

java.util.SortedSet<Speck>

OctTreeField.findRecipients(Speck sender, MessageShell shell, float time) Finds the recipients of a broadcast

Methods in com.speckled.specksim.imp.comm with parameters of type Speck

float	DefaultCommsModel.broadcast(Speck speck, Message message, MessageShell shell)
boolean	DefaultCommsModel.carrierSense(Speck speck, int channelID)
java.util.SortedSet<Speck>	OctTreeField.findRecipients(Speck sender, MessageShell shell, float time) Finds the recipients of a broadcast
void	DefaultCommsModel.initiateBroadcast(Speck speck, Message m, MessageShell shell, MACProtocol mac)
void	DefaultCommsModel.initiateBroadcast(Speck speck, MessageProducer mp, MessageShell shell, MACProtocol mac)
void	AbstractMac.initiateBroadcast(SpeckSim simulator, CommunicationModel commsModel, Speck speck, MessageShell shell, MessageProducer m)
float	DefaultCommsModel.isBroadcasting(Speck speck, int channelID)

Uses of Speck in com.speckled.specksim.imp.env

Methods in com.speckled.specksim.imp.env with parameters of type Speck

void	TemperatureEnvironment.setSpeckTemp(Speck s, float temp) Called by a speck to set it's temperature.

Uses of Speck in com.speckled.specksim.imp.motion

Methods in com.speckled.specksim.imp.motion with parameters of type Speck

SpeckPosition	WaypointMovementModel.computeLocation(Speck speck, float time)
SpeckPosition	SpeckledBodyModel.computeLocation(Speck speck, float time)
protected SpeckPosition	GridMovementModel.computeLocation(Speck speck, float time)
protected abstract SpeckPosition	CacheingMovementModel.computeLocation(Speck speck, float time) Override this to compute a speck's location
protected SpeckPosition	StaticMovementModel.computeLocation(Speck speck, float time)
Vector3d	WaypointMovementModel.computeVelocity(Speck speck, float time)
Vector3d	SpeckledBodyModel.computeVelocity(Speck speck, float time)
Vector3d	GridMovementModel.computeVelocity(Speck speck, float time)
protected abstract Vector3d	CacheingMovementModel.computeVelocity(Speck speck, float time) Override this to compute a speck's velocity
Vector3d	StaticMovementModel.computeVelocity(Speck speck, float time)
SpeckPosition	CacheingMovementModel.getSpeckOrientation(Speck speck, float time)
Vector3d	CacheingMovementModel.getSpeckVelocity(Speck speck, float time)
void	WaypointMovementModel.removeSpeck(Speck speck)
void	SpeckledBodyModel.removeSpeck(Speck speck)
void	GridMovementModel.removeSpeck(Speck speck)
void	StaticMovementModel.removeSpeck(Speck speck)
void	GridMovementModel.speckAdded(Speck speck)
void	GridMovementModel.speckRemoved(Speck speck)

Uses of Speck in com.speckled.specksim.imp.shells

Methods in com.speckled.specksim.imp.shells with parameters of type Speck

boolean	PerfectRadioShell.hit(Speck sender, SpeckPosition senderOrientation, Speck target, SpeckPosition targetOrientation)
boolean	RealisticRadioShell.hit(Speck sender, SpeckPosition senderOrientation, Speck target, SpeckPosition targetOrientation)
boolean	CollimatedShell.hit(Speck sender, SpeckPosition senderOrientation, Speck target, SpeckPosition targetOrientation)
boolean	EllipsoidShell.hit(Speck sender, SpeckPosition senderOrientation, Speck target, SpeckPosition targetOrientation)

Uses of Speck in com.speckled.specksim.imp.specks

Classes in com.speckled.specksim.imp.specks that implement Speck

class	AbstractSpeck Eases implementation by handling allocation of ids, logging control and repeatable random number generation.
class	CollisionSpeck This speck type continually broadcasts extremely long messages.
class	FloodSpeck This speck type forwards messages from its neighbours
class	NeighbourlySpeck This speck implementation simply broadcasts its id periodically, and keeps a decaying list of all the IDs it has received.
class	VelocitySpeck An extremely simple speck type.

Methods in com.speckled.specksim.imp.specks with parameters of type Speck

void	VelocitySpeck.shellEncountered(Speck sender, MessageShell shell, Message message)
void	NeighbourlySpeck.shellEncountered(Speck sender, MessageShell shell, Message message)
void	FloodSpeck.shellEncountered(Speck sender, MessageShell shell, Message message)
void	CollisionSpeck.shellEncountered(Speck sender, MessageShell shell, Message message)

Uses of Speck in com.speckled.specksim.listener

Methods in com.speckled.specksim.listener with parameters of type Speck

void	PopulationListener.speckAdded(Speck speck) Notifies the listener that an arbitrary Speck has been added
void	PopulationListener.speckRemoved(Speck speck) Notifies the listener that a speck has been removed