com.speckled.specksim.state
Interface SpeckState

All Known Subinterfaces:
AssociateAware, ClusterAware, EpidemicAwareSpeck, LeaderAware, NeighbourhoodAware, VelocityAware

public interface SpeckState

Every Speck must be able to supply a SpeckState object. The SpeckState object encapsulates all the data in the speck that we are interested in, and is used for statistic gathering, visualisation and so on. The SpeckState object is essentially a static snapshot of the state of the Speck at the time at which it was taken.

Author:
ryanm

Method Summary
 java.lang.String getFlavourName()
          Gets the name of the Speck type that generated this state object
 int id()
          Gets a unique identifier for this speck
 boolean ledStatus()
          Indicates the status of the speck's led
 

Method Detail

id

int id()
Gets a unique identifier for this speck

Returns:
an integer identifier

ledStatus

boolean ledStatus()
Indicates the status of the speck's led

Returns:
true if the led is on, false otherwise

getFlavourName

java.lang.String getFlavourName()
Gets the name of the Speck type that generated this state object

Returns:
The name of the parent speck type