Class EqualsOperation

java.lang.Object
org.kigalisim.lang.operation.EqualsOperation
All Implemented Interfaces:
Operation
public class EqualsOperation extends Object implements Operation
Operation that sets a consumption value in the engine.

This operation calculates a value and sets it as a consumption value in the engine. It can optionally be limited to a specific time period using a ParsedDuring object.

  • Constructor Details

    • EqualsOperation

      public EqualsOperation(Operation valueOperation)
      Create a new EqualsOperation that applies to all years.
      Parameters:
      valueOperation - The operation that calculates the value to set.

    • EqualsOperation

      public EqualsOperation(Operation valueOperation, ParsedDuring during)
      Create a new EqualsOperation that applies to a specific time period.
      Parameters:
      valueOperation - The operation that calculates the value to set.
      during - The time period during which this operation applies.

  • Method Details

    • execute

      public void execute(PushDownMachine machine)
      Execute the calculation and leave the result at the top of the stack.
      Specified by:
      execute in interface Operation
      Parameters:
      machine - The machine in which to execute the calculation if needed.

    • getStaticSemantics

      public OperationStaticSemantics getStaticSemantics()
      Get a record describing this operation's semantics.

      Get a record describing this operation's semantics that are inferrable from its static expression in code. In other words, properties and effects which do not require inspection at time of executing the operation.

      Specified by:
      getStaticSemantics in interface Operation
      Returns:
      Inference of common static properties found for this operation.