com.speckled.specksim.imp.state
Interface ClusterAware

All Superinterfaces:

SpeckState

public interface ClusterAware
extends SpeckState

Denotes a SpeckState that has cluster information

Author:

ryanm

Method Summary

int	getColour() Gets the current colour code of this Speck
int	getMaxAllowedZoneSize() Gets this speck's upper zone size limit
int	getMinAllowedZoneSize() Gets this speck's lower zone size limit
int	getZoneID() Gets the zone id of this speck
int	getZoneSize() Gets the size of this speck's zone

Methods inherited from interface com.speckled.specksim.state.SpeckState

getFlavourName, id, ledStatus

Method Detail

getColour

int getColour()

Gets the current colour code of this Speck

Returns:

An integer representing the colour of this speck

getZoneID

int getZoneID()

Gets the zone id of this speck

Returns:

The current zone id

getZoneSize

int getZoneSize()

Gets the size of this speck's zone

Returns:

The number of Specks in the zone

getMinAllowedZoneSize

int getMinAllowedZoneSize()

Gets this speck's lower zone size limit

Returns:

The minimum required number of specks in the zone

getMaxAllowedZoneSize

int getMaxAllowedZoneSize()

Gets this speck's upper zone size limit

Returns:

The maximum required number of specks in the zone