java.lang.Object

application.model.rules.hrot.MultistateCyclicHROT

All Implemented Interfaces:: ApgtableGeneratable, java.lang.Cloneable

public class MultistateCyclicHROT
extends BaseHROT
implements ApgtableGeneratable

Implements the multi-state cyclic HROT rulespace

Field Summary

Fields inherited from class application.model.rules.hrot.BaseHROT
hrotTransitions, maxNeighbourhoodCount, neighbourhood, neighbourhoodRegex, weights

Fields inherited from class application.model.rules.RuleFamily
name, rulestring

Fields inherited from class application.model.rules.Rule
alternatingPeriod, background, boundedGrid, numStates, readingOrder, tiling

Constructor Summary

Constructors
Constructor	Description
`MultistateCyclicHROT()`	Constructs Yoel's Gluonic rule
`MultistateCyclicHROT(java.lang.String rulestring)`	Creates a multi-state cyclic HROT rule with the given rulestring

Method Summary

Modifier and Type	Method	Description
`java.lang.String`	`canonise(java.lang.String rulestring)`	Canonises the inputted rulestring with the currently loaded parameters.
`java.lang.Object`	`clone()`	Clones the object
`protected void`	`fromRulestring(java.lang.String rulestring)`	Loads the rule's parameters from a rulestring
`RuleDirective[]`	`generateApgtable()`	Generates an apgtable for apgsearch to use
`java.lang.String`	`getDescription()`	Returns a plain text description of the rule family to be displayed in the Rule Dialog
`java.lang.String[]`	`getRegex()`	The regexes that will match a valid rulestring
`int`	`transitionFunc(int[] neighbours, int cellState, int generations, Coordinate coordinate)`	This method represents the transition function of the rule

Methods inherited from class application.model.rules.hrot.BaseHROT

generateComments, getNeighbourhood, getNeighbourhoodSpecifier, getRuleInfo, getWeights, loadComments, loadNeighbourhood, setNeighbourhood, setWeights

Methods inherited from class application.model.rules.RuleFamily

equals, getName, getNeighbourList, getRulestring, hashCode, setRulestring, toString, updateBackground

Methods inherited from class application.model.rules.Rule

convertState, dependsOnNeighbours, getAlternatingPeriod, getBoundedGrid, getColour, getName, getNeighbourhood, getNumStates, getTiling, setBackground, setBoundedGrid, setReadingOrder, step

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- MultistateCyclicHROT
  
  public MultistateCyclicHROT()
  
  Constructs Yoel's Gluonic rule
- MultistateCyclicHROT
  
  public MultistateCyclicHROT(java.lang.String rulestring)
  
  Creates a multi-state cyclic HROT rule with the given rulestring
  
  Parameters:
  
  rulestring - The rulestring of the multi-state cyclic HROT rule to be created
  
  Throws:
  
  java.lang.IllegalArgumentException - Thrown if the rulestring is invalid
Method Details
- fromRulestring
  
  protected void fromRulestring(java.lang.String rulestring)
  
  Description copied from class: RuleFamily
  
  Loads the rule's parameters from a rulestring
  
  Specified by:
  
  fromRulestring in class RuleFamily
  
  Parameters:
  
  rulestring - The rulestring of the rule (eg. B3/S23, R2,C2,S5-9,B7-8,NM)
- canonise
  
  public java.lang.String canonise(java.lang.String rulestring)
  
  Description copied from class: RuleFamily
  
  Canonises the inputted rulestring with the currently loaded parameters. This method should be called whenever the parameters of a rule are updated.
  
  Specified by:
  
  canonise in class RuleFamily
  
  Parameters:
  
  rulestring - The rulestring to canonised
  
  Returns:
  
  Canonised rulestring
- getRegex
  
  public java.lang.String[] getRegex()
  
  Description copied from class: RuleFamily
  
  The regexes that will match a valid rulestring
  
  Specified by:
  
  getRegex in class RuleFamily
  
  Returns:
  
  An array of regexes that will match a valid rulestring
- getDescription
  
  public java.lang.String getDescription()
  
  Description copied from class: RuleFamily
  
  Returns a plain text description of the rule family to be displayed in the Rule Dialog
  
  Specified by:
  
  getDescription in class RuleFamily
  
  Returns:
  
  Description of the rule family
- generateApgtable
  
  public RuleDirective[] generateApgtable() throws java.lang.UnsupportedOperationException
  
  Description copied from interface: ApgtableGeneratable
  
  Generates an apgtable for apgsearch to use
  
  Specified by:
  
  generateApgtable in interface ApgtableGeneratable
  
  Returns:
  
  Returns an array of rule directives to be placed in the ruletable
  
  Throws:
  
  java.lang.UnsupportedOperationException
- clone
  
  public java.lang.Object clone()
  
  Description copied from class: RuleFamily
  
  Clones the object
  
  Specified by:
  
  clone in class RuleFamily
  
  Returns:
  
  A deepcopy of the object
- transitionFunc
  
  public int transitionFunc(int[] neighbours, int cellState, int generations, Coordinate coordinate)
  
  Description copied from class: Rule
  
  This method represents the transition function of the rule
  
  Specified by:
  
  transitionFunc in class Rule
  
  Parameters:
  
  neighbours - The cell's neighbours in the order of the neighbourhood provided
  
  cellState - The current state of the cell
  
  generations - The current generation of the simulation
  
  coordinate - The coordinate of the cell
  
  Returns:
  
  The state of the cell in the next generation

Class MultistateCyclicHROT

Field Summary

Fields inherited from class application.model.rules.hrot.BaseHROT

Fields inherited from class application.model.rules.RuleFamily

Fields inherited from class application.model.rules.Rule