Real-Time Java AOCS Framework v1.0 API Specification

JbedSmmApplication.SequentialDataProcessing
Class JbedSmmPid

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.SequentialDataProcessing.AbstractControlChannel
                    |
                    +--RtjAocsFramework.SequentialDataProcessing.ControlChannelSuperBlock
                          |
                          +--JbedSmmApplication.SequentialDataProcessing.JbedSmmPid
All Implemented Interfaces:
Configurable, DataSink, DataSource, Resettable, Telemeterable

public class JbedSmmPid
extends ControlChannelSuperBlock

Application specific component implementing a PID controller for SMM application.

Version:
1.0
Author:
V. Cechticky/A. Pasetti (ETH-Zurich)

Field Summary
 
Fields inherited from class RtjAocsFramework.SequentialDataProcessing.ControlChannelSuperBlock
inputLink, outputLink
 
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
JbedSmmPid()
          Constructs a new PID controller.
 
Method Summary
 double getDgain()
          Gets a gain of the derivative part.
 double getIgain()
          Gets a gain of the integral part.
 RecoveryAction getIllegalTimeRecoveryAction()
          The getter method for illegal time recovery action.
 double getMaximumDerivative()
          Gets a maximum derivative of the derivative part.
 double getPgain()
          Gets a gain of the proportional part.
 void setDgain(double gain)
          Sets a gain of the derivative part.
 void setIgain(double gain)
          Sets a gain of the integral part.
 void setIllegalTimeRecoveryAction(RecoveryAction recoveryAction)
          The setter method for illegal time recovery action.
 void setMaximumDerivative(double maxDerivative)
          Sets a maximum derivative of the derivative part.
 void setPgain(double gain)
          Sets a gain of the proportional part.
 
Methods inherited from class RtjAocsFramework.SequentialDataProcessing.ControlChannelSuperBlock
getOutput, isConfigured, isOnHold, linkInput, linkInput, linkInputInternal, linkOutputInternal, propagate, reset, resetConfiguration, setInput, setOnHold
 
Methods inherited from class RtjAocsFramework.SequentialDataProcessing.AbstractControlChannel
getEnclosingControlChannel, getLastPropagatedTime, getNumberOfInputs, getNumberOfOutputs, getPropagationToken, reset, setEnclosingControlChannel, setNumberOfInputs, setNumberOfOutputs, setPropagationToken
 
Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject
addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getCycle, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, getTelemetryImageLength, getTime, removeConfigurationListener, removeFailureListener, reportConfigurationEvent, reportFailure, resetStaticConfiguration, setAocsClock, setDestructionRecoveryAction, setMaxNumberOfConfigurationListeners, setMaxNumberOfFailureListeners, setSystemManager, setTelemetryFormat, writeToTelemetry
 
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

JbedSmmPid

public JbedSmmPid()
Constructs a new PID controller.

Method Detail

setPgain

public void setPgain(double gain)
Sets a gain of the proportional part.

Parameters:
gain -

getPgain

public double getPgain()
Gets a gain of the proportional part.

Returns:

setIgain

public void setIgain(double gain)
Sets a gain of the integral part.

Parameters:
gain -

getIgain

public double getIgain()
Gets a gain of the integral part.

Returns:

setDgain

public void setDgain(double gain)
Sets a gain of the derivative part.

Parameters:
gain -

getDgain

public double getDgain()
Gets a gain of the derivative part.

Returns:

setMaximumDerivative

public void setMaximumDerivative(double maxDerivative)
Sets a maximum derivative of the derivative part.

Parameters:
maxDerivative - the new value of the maximum derivative

getMaximumDerivative

public double getMaximumDerivative()
Gets a maximum derivative of the derivative part.

Returns:
the maximum derivative

setIllegalTimeRecoveryAction

public void setIllegalTimeRecoveryAction(RecoveryAction recoveryAction)
The setter method for illegal time recovery action.

Overrides:
setIllegalTimeRecoveryAction in class AbstractControlChannel
Parameters:
recoveryAction - the illegal time recovery action

getIllegalTimeRecoveryAction

public RecoveryAction getIllegalTimeRecoveryAction()
The getter method for illegal time recovery action.

Overrides:
getIllegalTimeRecoveryAction in class AbstractControlChannel
Returns:
the illegal time recovery action

Real-Time Java AOCS Framework v1.0 API Specification

Real-Time Java AOCS Framework project home page

Automatic Control Laboratory, ETH Zuerich
Physikstrasse 3
CH-8092 Zuerich, Switzerland