org.rvpf.processor.engine.rpn

Class RPNTransform

Object

Proxied.Abstract

AbstractTransform

RPNTransform

All Implemented Interfaces:

Transform, Proxied

public final class RPNTransform
extends AbstractTransform

RPN transform.

Instances of this class apply the RPN program from its '"Program"' parameter. This program is compiled on startup, using the macro and word definitions supplied by the'' and'' parameters for itself and its engine.

See Also:

RPNEngine

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields inherited from interface Transform

ACTION_PARAM, CEILING_INTERVAL_PARAM, CEILING_RATIO_PARAM, FAIL_RETURNS_NULL_PARAM, FINAL_PROGRAM_PARAM, FLOOR_INTERVAL_PARAM, FLOOR_RATIO_PARAM, INITIAL_PROGRAM_PARAM, NULL_REMOVES_PARAM, PARAM_PARAM, PROGRAM_PARAM, STEP_PROGRAM_PARAM

Constructor Summary

Constructors

Constructor and Description
RPNTransform(RPNEngine engine) Constructs a RPN transform.

Method Summary

Modifier and Type	Method and Description
Optional<PointValue>	applyTo(ResultValue resultValue, Batch batch) Applies the program to provide the specified result value.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.
boolean	usesFetchedResult() Asks if this transform needs the fetched result value.

Methods inherited from class AbstractTransform

addUpdate, getInstance, isNullRemoves, setUp

Methods inherited from class Proxied.Abstract

getMetadata, getName, getParams, getProxyEntity, getThisLogger, tearDown

Methods inherited from class Object

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

Methods inherited from interface Proxied

getName, getParams, getProxyEntity, tearDown

Constructor Detail

RPNTransform

public RPNTransform(@Nonnull
                    RPNEngine engine)

Constructs a RPN transform.

Parameters:

engine - The RPN engine.

Method Detail

applyTo

public Optional<PointValue> applyTo(ResultValue resultValue,
                                    Batch batch)

Applies the program to provide the specified result value.

When this method is called, the result value must have been provided with all its needed input values.

Note: the returned value is not required to be an instance of the ResultValue class.

Parameters:

resultValue - The result value needing update.

batch - The current batch.

Returns:

The resulting point value or empty.

setUp

public boolean setUp(Metadata metadata,
                     ProxyEntity proxyEntity)

Sets up the instance for action.

Specified by:

setUp in interface Proxied

Overrides:

setUp in class AbstractTransform

Parameters:

metadata - The metadata available to the current process.

proxyEntity - The proxy entity refering to the proxied.

Returns:

True on success.

usesFetchedResult

public boolean usesFetchedResult()

Asks if this transform needs the fetched result value.

Specified by:

usesFetchedResult in interface Transform

Overrides:

usesFetchedResult in class AbstractTransform

Returns:

True if the result is used.