RtjAocsFramework.SequentialDataProcessing
Class MatlabGainBlock

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

All Implemented Interfaces:

Configurable, DataSink, DataSource, Resettable, Telemeterable

public class MatlabGainBlock

extends MatlabBlock

Control block acting as a container for an autocode procedure generated by Matlab.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Vaclav Cechticky (IfA ETHZ)

See Also:

The Sequential Data Processing Framelet Document

Field Summary

Fields inherited from class RtjAocsFramework.SequentialDataProcessing.MatlabBlock

matlabErrorRecoveryAction

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

MatlabGainBlock(int samplingTime)
Creates a new MatlabGainBlock object with the specified sampling time.

Method Summary

protected String	ErrorStatus() Getter method for the error status.
protected double	getGain() Getter method for the tunable gain.
protected double	getInputSignal() Getter method for the external input signal.
protected double	getOutputSignal() Getter method for the external output signal.
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	init(boolean initFlag) Initializes the real-time object, external inputs and outputs.
protected void	internalLoadInput() Sets the input signal of the matlab model.
protected void	internalUpdateOutput() Loads the value of the model output signal into output buffer.
void	reset() Resets super object state and performs the local reset.
void	resetConfiguration() Resets configuration of the super object and performs the local reset of the configuration.
protected void	setGain(double newGain) Setter method for the tunable gain.
protected void	setInputSignal(double inputSignal) Setter method for the external input signal.
protected void	step() Performs all computations for one time step.
protected void	term() Performs any cleanup operations.
void	writeToTelemetry(TelemetryStream stream) Causes the object to write its own state to the telemetry stream.

Methods inherited from class RtjAocsFramework.SequentialDataProcessing.MatlabBlock

finalizeMatlabBlock, getMatlabErrorRecoveryAction, propagationAlgorithm, setMatlabErrorRecoveryAction

Methods inherited from class RtjAocsFramework.SequentialDataProcessing.ControlChannelBlock

getNumberOfStates, getOutput, getState, getValidityTime, isConfigured, isOnHold, linkInput, linkInput, propagate, 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

MatlabGainBlock

public MatlabGainBlock(int samplingTime)

Creates a new MatlabGainBlock object with the specified sampling time.

Parameters:

samplingTime - the sampling time of the matlab model

Method Detail

init

protected void init(boolean initFlag)

Initializes the real-time object, external inputs and outputs.

Specified by:

init in class MatlabBlock

Parameters:

initFlag - if the initFlag is true the function initializes data structures private to the model. If the initFlag is false the model resets the model's states.

step

protected void step()

Performs all computations for one time step.

Specified by:

step in class MatlabBlock

term

protected void term()

Performs any cleanup operations.

Specified by:

term in class MatlabBlock

setInputSignal

protected void setInputSignal(double inputSignal)

Setter method for the external input signal.

Parameters:

inputSignal - a new value of the input signal

getInputSignal

protected double getInputSignal()

Getter method for the external input signal.

Returns:

the value of the external input signal

getOutputSignal

protected double getOutputSignal()

Getter method for the external output signal.

Returns:

the value of the external output signal

setGain

protected void setGain(double newGain)

Setter method for the tunable gain.

Parameters:

newGain - a new value of the gain

getGain

protected double getGain()

Getter method for the tunable gain.

Returns:

the value of the gain

ErrorStatus

protected String ErrorStatus()

Getter method for the error status.

Specified by:

ErrorStatus in class MatlabBlock

Returns:

the error status

internalLoadInput

protected void internalLoadInput()

Sets the input signal of the matlab model.

Specified by:

internalLoadInput in class MatlabBlock

internalUpdateOutput

protected void internalUpdateOutput()

Loads the value of the model output signal into output buffer.

Specified by:

internalUpdateOutput in class MatlabBlock

reset

public void reset()

Resets super object state and performs the local reset.

Specified by:

reset in interface Resettable

Overrides:

reset in class MatlabBlock

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 MatlabBlock

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 MatlabBlock

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 MatlabBlock

Parameters:

stream - the telemetry stream