Module org.yamcs.sle

Package org.yamcs.sle

Class AbstractTmSleLink

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.tctm.AbstractLink

org.yamcs.tctm.ccsds.AbstractTmFrameLink

org.yamcs.sle.AbstractTmSleLink

All Implemented Interfaces:

com.google.common.util.concurrent.Service, org.yamcs.jsle.user.FrameConsumer, SystemParametersProducer, SleLink, AggregatedDataLink, Link, LinkActionProvider, ParameterDataLink

Direct Known Subclasses:

OfflineTmSleLink, TmSleLink

public abstract class AbstractTmSleLink
extends AbstractTmFrameLink
implements org.yamcs.jsle.user.FrameConsumer, SleLink, ParameterDataLink

Abstract class for the TM SLE links.

It implements the common functionality for Offline and Online links.

Nested Class Summary

Nested classes/interfaces inherited from interface org.yamcs.tctm.Link

Link.Status

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field	Description
protected ParameterSink	parameterSink

Fields inherited from class org.yamcs.tctm.ccsds.AbstractTmFrameLink

errFrameCount, frameHandler, invalidFrameCount, rawFrameDecoder, subLinks, TM_FRAME_CONFIG_SECTION, validFrameCount

Fields inherited from class org.yamcs.tctm.AbstractLink

config, dataInCount, dataOutCount, disabled, eventProducer, LINK_NAMESPACE, linkName, log, timeService, yamcsInstance

Constructor Summary

Constructors

Constructor	Description
AbstractTmSleLink()

Method Summary

Modifier and Type	Method	Description
void	acceptFrame(org.yamcs.jsle.CcsdsTime ert, org.yamcs.jsle.AntennaId antennaId, int dataLinkContinuity, org.yamcs.jsle.Constants.FrameQuality frameQuality, byte[] privAnn, byte[] data)
protected void	collectSystemParameters(long time, List<ParameterValue> list)
protected void	connectAndBind(boolean startSle)
protected Link.Status	connectionStatus()	Verifies that the requested state is the same as the current state
Spec	getDefaultSpec()
String	getDetailedStatus()
Map<String,Object>	getExtraInfo()
CompletableFuture<org.yamcs.jsle.SleParameter>	getParameter(org.yamcs.jsle.ParameterName paraName)	Retrieve the value for the parameter from the SLE provider
void	init(String instance, String name, YConfiguration config, org.yamcs.jsle.Constants.DeliveryMode deliveryMode)	parses and validates configuration
boolean	isParameterDataLinkImplemented()
void	onExcessiveDataBacklog()
void	onLossFrameSync(org.yamcs.jsle.CcsdsTime time, org.yamcs.jsle.Constants.LockStatus carrier, org.yamcs.jsle.Constants.LockStatus subcarrier, org.yamcs.jsle.Constants.LockStatus symbolSync)
void	onProductionStatusChange(org.yamcs.jsle.Constants.ProductionStatus productionStatusChange)
void	setParameterSink(ParameterSink parameterSink)
void	setupSystemParameters(SystemParametersService sps)

Methods inherited from class org.yamcs.tctm.ccsds.AbstractTmFrameLink

addDefaultOptions, getSubLinks, handleFrame, init, resetCounters

Methods inherited from class org.yamcs.tctm.AbstractLink

addAction, dataIn, dataOut, disable, doDisable, doEnable, enable, getAction, getActions, getConfig, getCurrentTime, getDataInCount, getDataOutCount, getEventLoop, getLinkStatus, getName, getParent, getSystemParameters, getYamcsInstance, isDisabled, isRunningAndEnabled, setParent

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, doCancelStart, doStart, doStop, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.jsle.user.FrameConsumer

onEndOfData

Methods inherited from interface org.yamcs.tctm.Link

disable, enable, getConfig, getDataInCount, getDataOutCount, getLinkStatus, getName, getParent, getSpec, init, isDisabled, isEffectivelyDisabled, resetCounters, setParent

Methods inherited from interface org.yamcs.parameter.SystemParametersProducer

getFrequency

Field Details

parameterSink

protected ParameterSink parameterSink

Constructor Details

AbstractTmSleLink

public AbstractTmSleLink()

Method Details

getDefaultSpec

public Spec getDefaultSpec()

Specified by:

getDefaultSpec in interface Link

Overrides:

getDefaultSpec in class AbstractTmFrameLink

init

public void init(String instance,
 String name,
 YConfiguration config,
 org.yamcs.jsle.Constants.DeliveryMode deliveryMode)
          throws ConfigurationException

parses and validates configuration

Parameters:

deliveryMode -

Throws:

ConfigurationException - if port is not defined in the configuration

connectAndBind

protected void connectAndBind(boolean startSle)

connectionStatus

protected Link.Status connectionStatus()

Verifies that the requested state is the same as the current state

Specified by:

connectionStatus in class AbstractLink

Returns:

Status.OK or Status.UNAVAIL

getDetailedStatus

public String getDetailedStatus()

Specified by:

getDetailedStatus in interface Link

Overrides:

getDetailedStatus in class AbstractLink

getExtraInfo

public Map<String,Object> getExtraInfo()

Specified by:

getExtraInfo in interface Link

acceptFrame

public void acceptFrame(org.yamcs.jsle.CcsdsTime ert,
 org.yamcs.jsle.AntennaId antennaId,
 int dataLinkContinuity,
 org.yamcs.jsle.Constants.FrameQuality frameQuality,
 byte[] privAnn,
 byte[] data)

Specified by:

acceptFrame in interface org.yamcs.jsle.user.FrameConsumer

onExcessiveDataBacklog

public void onExcessiveDataBacklog()

Specified by:

onExcessiveDataBacklog in interface org.yamcs.jsle.user.FrameConsumer

onProductionStatusChange

public void onProductionStatusChange(org.yamcs.jsle.Constants.ProductionStatus productionStatusChange)

Specified by:

onProductionStatusChange in interface org.yamcs.jsle.user.FrameConsumer

onLossFrameSync

public void onLossFrameSync(org.yamcs.jsle.CcsdsTime time,
 org.yamcs.jsle.Constants.LockStatus carrier,
 org.yamcs.jsle.Constants.LockStatus subcarrier,
 org.yamcs.jsle.Constants.LockStatus symbolSync)

Specified by:

onLossFrameSync in interface org.yamcs.jsle.user.FrameConsumer

setupSystemParameters

public void setupSystemParameters(SystemParametersService sps)

Specified by:

setupSystemParameters in interface Link

Overrides:

setupSystemParameters in class AbstractLink

collectSystemParameters

protected void collectSystemParameters(long time,
 List<ParameterValue> list)

Overrides:

collectSystemParameters in class AbstractLink

getParameter

public CompletableFuture<org.yamcs.jsle.SleParameter> getParameter(org.yamcs.jsle.ParameterName paraName)

Description copied from interface: SleLink

Retrieve the value for the parameter from the SLE provider

Specified by:

getParameter in interface SleLink

isParameterDataLinkImplemented

public boolean isParameterDataLinkImplemented()

Specified by:

isParameterDataLinkImplemented in interface ParameterDataLink

setParameterSink

public void setParameterSink(ParameterSink parameterSink)

Specified by:

setParameterSink in interface ParameterDataLink