org.rvpf.processor.behavior

Class Synchronized

Object

AbstractBehavior

PrimaryBehavior

Synchronized

All Implemented Interfaces:

Behavior, Proxied

public final class Synchronized
extends PrimaryBehavior

Synchronized behavior.

As a primary behavior, will triggers the computation of a result with the same timestamp.

It can also be used as a secondary behavior to limit the supply of values to those with the same timestamp as the result (this is adjusted to accomodate synchronization mismatch).

Interpolation and extrapolation are supported.

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
Synchronized()

Method Summary

Modifier and Type	Method and Description
protected boolean	doValidate() Does validate this behavior.
boolean	isInputValid(PointValue inputValue, ResultValue resultValue) Asks if a point value is valid for the computation of a result value.
boolean	isSynchronized() Asks if this behavior is synchronized.
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.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.
protected boolean	supportsExtrapolated() Asks if this behavior supports extrapolated values.
protected boolean	supportsInterpolated() Asks if this behavior supports interpolated values.
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, 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, isResultFetched, newResultValue, setInherited, setNext, setRelation, tearDown, toString, validateNoResults, validateTransform

Methods inherited from class Object

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

Constructor Detail

Synchronized

public Synchronized()

Method Detail

isInputValid

public boolean isInputValid(PointValue inputValue,
                            ResultValue resultValue)

Asks if a point value is valid for the computation of a result value.

Specified by:

isInputValid in interface Behavior

Overrides:

isInputValid in class AbstractBehavior

Parameters:

inputValue - The point value.

resultValue - The result value.

Returns:

True if the point value is valid.

isSynchronized

public boolean isSynchronized()

Asks if this behavior is synchronized.

Specified by:

isSynchronized in interface Behavior

Overrides:

isSynchronized in class AbstractBehavior

Returns:

True if it is synchronized.

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.

Unless there is already an input value at the result's time adjusted to the sync position, asks for one.

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.

Asks for a result at the notice's time adjusted to the sync position. When an adjustment is effective, asks for an input value for the same time as the result.

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.

Selects the input value at the result's time adjusted to the sync position.

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.

setUp

public boolean setUp(Metadata metadata,
                     ProxyEntity proxyEntity)

Sets up the instance for action.

Specified by:

setUp in interface Proxied

Overrides:

setUp in class PrimaryBehavior

Parameters:

metadata - The metadata available to the current process.

proxyEntity - The proxy entity refering to the proxied.

Returns:

True on success.

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 there is no time adjustment or if an input value is available at the adjusted time, triggers the result's computation.

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.

supportsExtrapolated

protected boolean supportsExtrapolated()

Asks if this behavior supports extrapolated values.

Overrides:

supportsExtrapolated in class PrimaryBehavior

Returns:

True if it supports extrapolated values.

supportsInterpolated

protected boolean supportsInterpolated()

Asks if this behavior supports interpolated values.

Overrides:

supportsInterpolated in class PrimaryBehavior

Returns:

True if it supports interpolated values.