org.rvpf.processor.engine.control

Class ControlsBehavior

Object

AbstractBehavior

PrimaryBehavior

ControlsBehavior

All Implemented Interfaces:

Behavior, Proxied

public final class ControlsBehavior
extends PrimaryBehavior

Controls behavior.

Always triggers the computation of a result with the same timestamp as the notice.

It is always associated with the only input of a control transform.

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields inherited from class PrimaryBehavior

AFTER_RESULT_SYNC_POSITION_PARAM, FILTER_STAMP_TRIM_UNIT_PARAM, FILTER_TIME_LIMIT_PARAM, POLATOR_TIME_LIMIT_PARAM, SELECT_PREVIOUS_VALUE_PARAM, SELECT_SYNC_POSITION_PARAM, SINCE_RESULT_SYNC_POSITION_PARAM, SINCE_SYNC_POSITION_PARAM

Constructor Summary

Constructors

Constructor and Description
ControlsBehavior()

Method Summary

Modifier and Type	Method and Description
protected boolean	doValidate() Does validate this behavior.
boolean	prepareSelect(ResultValue resultValue, Batch batch) Allows a behavior to prepare for a call to Behavior.select(org.rvpf.base.value.ResultValue, org.rvpf.metadata.processor.Batch).
boolean	prepareTrigger(PointValue noticeValue, Batch batch) Allows a behavior to prepare for a call to Behavior.trigger(org.rvpf.base.value.PointValue, org.rvpf.metadata.processor.Batch).
boolean	select(ResultValue resultValue, Batch batch) Selects input values for computing the result.
void	trigger(PointValue noticeValue, Batch batch) Triggers the computation of results if needed.

Methods inherited from class PrimaryBehavior

addInputToResult, equals, getAfterResultSyncPosition, getInputSync, getResultSync, getResultSyncStamp, getSelectSyncPosition, getSinceResultSyncPosition, getSinceSyncPosition, getSync, getSynchronizedResultStamp, getSyncStamp, hasAfterResultSyncPosition, hashCode, hasSelectSyncPosition, hasSinceResultSyncPosition, hasSinceSyncPosition, isInSync, isPrimary, isSelectPreviousValue, setUp, supportsExtrapolated, supportsInterpolated, validate, validateNoLoop, validateNotSynchronized

Methods inherited from class AbstractBehavior

getBehavior, getBooleanInputValue, getDoubleInputValue, getElapsedInputValue, getEntity, getInput, getInputPoint, getName, getNext, getParams, getProxyEntity, getRelation, getRelations, getRelationSync, getRelationSyncEntity, getResultPoint, getThisLogger, getTransform, isInherited, isInputExtrapolated, isInputInterpolated, isInputRequired, isInputValid, isResultFetched, isSynchronized, newResultValue, setInherited, setNext, setRelation, tearDown, toString, validateNoResults, validateTransform

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ControlsBehavior

public ControlsBehavior()

Method Detail

prepareSelect

public boolean prepareSelect(ResultValue resultValue,
                             Batch batch)

Allows a behavior to prepare for a call to Behavior.select(org.rvpf.base.value.ResultValue, org.rvpf.metadata.processor.Batch).

The result value has been triggered either by this behavior or the behavior of an other input. Will be called until all the batch behaviors return true.

Specified by:

prepareSelect in interface Behavior

Overrides:

prepareSelect in class PrimaryBehavior

Parameters:

resultValue - The result value to be computed.

batch - The current batch context.

Returns:

True if ready for select.

prepareTrigger

public boolean prepareTrigger(PointValue noticeValue,
                              Batch batch)

Allows a behavior to prepare for a call to Behavior.trigger(org.rvpf.base.value.PointValue, org.rvpf.metadata.processor.Batch).

Will be called until all the batch behaviors return true.

On the first pass, asks for the next notice.

Specified by:

prepareTrigger in interface Behavior

Overrides:

prepareTrigger in class AbstractBehavior

Parameters:

noticeValue - A point value acting as potential trigger.

batch - The current batch context.

Returns:

True if ready for trigger.

select

public boolean select(ResultValue resultValue,
                      Batch batch)

Selects input values for computing the result.

This is called after all the calls to the Behavior.prepareSelect(org.rvpf.base.value.ResultValue, org.rvpf.metadata.processor.Batch) method have returned true.

Specified by:

select in interface Behavior

Overrides:

select in class PrimaryBehavior

Parameters:

resultValue - The result value to be computed.

batch - The current batch context.

Returns:

False if a problem was identified.

trigger

public void trigger(PointValue noticeValue,
                    Batch batch)

Triggers the computation of results if needed.

This is called after all the calls to the Behavior.prepareTrigger(org.rvpf.base.value.PointValue, org.rvpf.metadata.processor.Batch) method have returned true.

If the notice is the last value of its point, sets up a result at the notice's time.

Specified by:

trigger in interface Behavior

Overrides:

trigger in class AbstractBehavior

Parameters:

noticeValue - A point value acting as potential trigger.

batch - The current batch context.

doValidate

protected boolean doValidate()

Does validate this behavior.

Overrides:

doValidate in class AbstractBehavior

Returns:

True when valid.