RtjAocsFramework.SequentialDataProcessing
Class LimitBlock

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.SequentialDataProcessing.AbstractControlChannel
                    |
                    +--RtjAocsFramework.SequentialDataProcessing.ControlChannelBlock
                          |
                          +--RtjAocsFramework.SequentialDataProcessing.LimitBlock

All Implemented Interfaces:

Configurable, DataSink, DataSource, Resettable, Telemeterable

public class LimitBlock

extends ControlChannelBlock

Control block to implement a simple limited output. The block implements the following multi-input-single-output transfer function: if (u > max), y = max else if (u < min), y = min else y = u

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Tim Brown, Vaclav Cechticky (IfA ETHZ)

See Also:

The Sequential Data Processing Framelet Document

Field Summary

Fields inherited from class RtjAocsFramework.SequentialDataProcessing.ControlChannelBlock

dataSourceOutputPosition, initFlag, input, inputLink, onHold, output, outputBuffer, p, state, validityTime

Fields inherited from class RtjAocsFramework.SequentialDataProcessing.AbstractControlChannel

ccLink, channelPropagation, enclosingControlChannel, lastPropagatedTime, m, n, noPropagation, propagationToken, recoveryAction, totalPropagation

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

LimitBlock()
Creates a new LimitBlock object.

Method Summary

int	getTelemetryImageLength() Return the length in bits of the telemetry image that would be written by the object in response to a call to method writeToTelemetry.
protected void	propagationAlgorithm(int t) The propagation algorithm of the limit block.
void	resetConfiguration() Resets configuration of the super object and performs the local reset of the configuration.
void	setLimits(double high, double low) Setter method for the high and low limit.
void	writeToTelemetry(TelemetryStream stream) Causes the object to write its own state to the telemetry stream.

Methods inherited from class RtjAocsFramework.SequentialDataProcessing.ControlChannelBlock

getNumberOfStates, getOutput, getState, getValidityTime, isConfigured, isOnHold, linkInput, linkInput, propagate, reset, resetMemory, setInput, setInputSize, setOnHold, setOutputSize, setState, setStateSize

Methods inherited from class RtjAocsFramework.SequentialDataProcessing.AbstractControlChannel

getEnclosingControlChannel, getIllegalTimeRecoveryAction, getLastPropagatedTime, getNumberOfInputs, getNumberOfOutputs, getPropagationToken, reset, setEnclosingControlChannel, setIllegalTimeRecoveryAction, setNumberOfInputs, setNumberOfOutputs, setPropagationToken

Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject

addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getCycle, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, getTime, removeConfigurationListener, removeFailureListener, reportConfigurationEvent, reportFailure, resetStaticConfiguration, setAocsClock, setDestructionRecoveryAction, setMaxNumberOfConfigurationListeners, setMaxNumberOfFailureListeners, setSystemManager, setTelemetryFormat

Methods inherited from class RtjAocsFramework.BasicObjects.RootObject

getClassId, getInstanceId, setClassId

Methods inherited from class java.lang.Object

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

Constructor Detail

LimitBlock

public LimitBlock()

Creates a new LimitBlock object.

Method Detail

propagationAlgorithm

protected void propagationAlgorithm(int t)

The propagation algorithm of the limit block.

Specified by:

propagationAlgorithm in class ControlChannelBlock

Parameters:

t - the target time

setLimits

public void setLimits(double high,
                      double low)

Setter method for the high and low limit.

Parameters:

high - the high limit

low - the low limit

resetConfiguration

public void resetConfiguration()

Resets configuration of the super object and performs the local reset of the configuration.

Specified by:

resetConfiguration in interface Configurable

Overrides:

resetConfiguration in class ControlChannelBlock

getTelemetryImageLength

public int getTelemetryImageLength()

Return the length in bits of the telemetry image that would be written by the object in response to a call to method writeToTelemetry.

Specified by:

getTelemetryImageLength in interface Telemeterable

Overrides:

getTelemetryImageLength in class AocsObject

Returns:

the length in bits of the telemetry image

writeToTelemetry

public void writeToTelemetry(TelemetryStream stream)

Causes the object to write its own state to the telemetry stream.

Specified by:

writeToTelemetry in interface Telemeterable

Overrides:

writeToTelemetry in class AocsObject

Parameters:

stream - the telemetry stream