Class CapDisplacingOperation

java.lang.Object

org.kigalisim.lang.operation.CapDisplacingOperation

All Implemented Interfaces:

Operation

public class CapDisplacingOperation
extends Object
implements Operation

Operation that caps a stream value to a specified maximum and displaces the excess.

This operation calculates a value and caps a specified stream in the engine to that maximum. The excess is displaced to another stream. It can optionally be limited to a specific time period using a ParsedDuring object.

Constructor Summary

Constructors

Constructor	Description
CapDisplacingOperation(String stream, Operation valueOperation, String displaceTarget)	Create a new CapDisplacingOperation that applies to all years.
CapDisplacingOperation(String stream, Operation valueOperation, String displaceTarget, ParsedDuring during)	Create a new CapDisplacingOperation 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

CapDisplacingOperation

public CapDisplacingOperation(String stream,
 Operation valueOperation,
 String displaceTarget)

Create a new CapDisplacingOperation that applies to all years.

Parameters:

stream - The name of the stream to cap.

valueOperation - The operation that calculates the maximum value.

displaceTarget - The name of the stream to displace excess to.

CapDisplacingOperation

public CapDisplacingOperation(String stream,
 Operation valueOperation,
 String displaceTarget,
 ParsedDuring during)

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

Parameters:

stream - The name of the stream to cap.

valueOperation - The operation that calculates the maximum value.

displaceTarget - The name of the stream to displace excess to.

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.