Package application.model.rules.hrot.history

Class HROTHistory

java.lang.Object
application.model.rules.Rule
application.model.rules.RuleFamily
application.model.rules.hrot.BaseHROT
application.model.rules.hrot.HROT
application.model.rules.hrot.history.HROTHistory
All Implemented Interfaces:
ApgtableGeneratable, MinMaxRuleable, java.lang.Cloneable
public class HROTHistory
extends HROT
implements ApgtableGeneratable
Represents a HROT History rule.

  • Constructor Details

    • HROTHistory

      public HROTHistory()
      Creates a HROT History rule with the rule Minibugs History

    • HROTHistory

      public HROTHistory​(java.lang.String rulestring)
      Creates a HROT History rule with the specified rulestring
      Parameters:
      rulestring - The rulestring of the history rule

  • Method Details

    • fromRulestring

      protected void fromRulestring​(java.lang.String rulestring) throws java.lang.IllegalArgumentException
      Loads the rule's parameters from a rulestring
      Overrides:
      fromRulestring in class HROT
      Parameters:
      rulestring - The rulestring of the HROT History rule (eg. B3/S23History, R2,C2,S6-9,B7-8,NMHistory)
      Throws:
      java.lang.IllegalArgumentException - Thrown if an invalid rulestring is passed in

    • canonise

      public java.lang.String canonise​(java.lang.String rulestring)
      Canonises the inputted rulestring with the currently loaded parameters.
      Overrides:
      canonise in class HROT
      Parameters:
      rulestring - The rulestring to canonised
      Returns:
      Canonised rulestring

    • getRegex

      public java.lang.String[] getRegex()
      The regexes that will match a valid rulestring
      Overrides:
      getRegex in class HROT
      Returns:
      An array of regexes that will match a valid rulestring

    • getDescription

      public java.lang.String getDescription()
      Returns a plain text description of the 2-state HROT History rule family to be displayed in the Rule Dialog
      Overrides:
      getDescription in class HROT
      Returns:
      Description of the 2-state HROT History rule family

    • generateApgtable

      public RuleDirective[] generateApgtable()
      Generates an apgtable for apgsearch to use
      Specified by:
      generateApgtable in interface ApgtableGeneratable
      Overrides:
      generateApgtable in class HROT
      Returns:
      True if the operation was successful, false otherwise

    • 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
      Overrides:
      transitionFunc in class HROT
      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

    • getColour

      public javafx.scene.paint.Color getColour​(int state)
      Returns the colour of a cell of the provided state
      Overrides:
      getColour in class Rule
      Parameters:
      state - The state of the cell
      Returns:
      The colour of the cell

    • dependsOnNeighbours

      public int dependsOnNeighbours​(int state, int generation, Coordinate coordinate)
      Description copied from class: Rule
      If the next state of the cell depends on its neighbours, return -1. If not return the next state of the cell.
      Overrides:
      dependsOnNeighbours in class Rule
      Parameters:
      state - The current state of the cell
      generation - The generation of the simulation
      coordinate - The coordinate of the cell
      Returns:
      Returns -1 or the next state of the cell

    • clone

      public java.lang.Object clone()
      Description copied from class: HROT
      Clones the rule
      Overrides:
      clone in class HROT
      Returns:
      Returns a deep copy of the HROT rule