Class ChangeOperation

java.lang.Object

org.kigalisim.lang.operation.ChangeOperation

All Implemented Interfaces:

Operation

public class ChangeOperation
extends Object
implements Operation

Operation that changes a stream value by a specified amount.

This operation calculates a value and changes a specified stream in the engine by that amount. It can optionally be limited to a specific time period using a ParsedDuring object.

Constructor Summary

Constructors

Constructor	Description
ChangeOperation(String stream, Operation valueOperation)	Create a new ChangeOperation that applies to all years.
ChangeOperation(String stream, Operation valueOperation, ParsedDuring during)	Create a new ChangeOperation that applies to a specific time period.

Method Summary

Modifier and Type	Method	Description
void	execute(PushDownMachine machine)	Execute the calculation and leave the result at the top of the stack.
OperationStaticSemantics	getStaticSemantics()	Get a record describing this operation's semantics.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ChangeOperation

public ChangeOperation(String stream,
 Operation valueOperation)

Create a new ChangeOperation that applies to all years.

Parameters:

stream - The name of the stream to change.

valueOperation - The operation that calculates the amount to change by.

ChangeOperation

public ChangeOperation(String stream,
 Operation valueOperation,
 ParsedDuring during)

Create a new ChangeOperation that applies to a specific time period.

Parameters:

stream - The name of the stream to change.

valueOperation - The operation that calculates the amount to change by.

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.