org.yamcs.xtceproc

Class XtceTmProcessor

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.xtceproc.XtceTmProcessor

All Implemented Interfaces:

com.google.common.util.concurrent.Service, ContainerProvider, ParameterProvider, TmSink, TmProcessor

public class XtceTmProcessor
extends com.google.common.util.concurrent.AbstractService
implements TmProcessor, ParameterProvider, ContainerProvider

Does the job of getting containers and transforming them into parameters which are then sent to the parameter request manager for the distribution to the requesters. Relies on XtceTmExtractor for extracting the parameters out of containers

Author:

mache

Nested Class Summary

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 and Description
Processor	processor
XtceDb	xtcedb

Constructor Summary

Constructors

Constructor and Description
XtceTmProcessor(Processor proc)
XtceTmProcessor(Processor proc, Map<String,Object> tmProcessorConfig)
XtceTmProcessor(XtceDb xtcedb) Creates a TmProcessor to be used in "standalone" mode, outside of any processor

Method Summary

Modifier and Type	Method and Description
boolean	canProvide(Parameter para)
boolean	canProvide(Yamcs.NamedObjectId paraId) Returns whether or not a given parameter can be provided by this provider
boolean	canProvideContainer(Yamcs.NamedObjectId containerId) Returns whether or not a given container can be provided by this provider
protected void	doStart()
protected void	doStop()
void	finished() Notification that there is no more packet to process
Container	getContainer(Yamcs.NamedObjectId containerId) Returns the containerDefinition corresponding to the itemId
Parameter	getParameter(Yamcs.NamedObjectId paraId) Returns the parameterDefinition corresponding to the parameter id
ProcessingStatistics	getStatistics()
Subscription	getSubscription()
XtceDb	getXtceDb()
void	init(Processor processor) Called before the startup to pass on the processor and initialize whatever needed
void	processPacket(PacketWithTime pwrt) Process telemetry packets
void	processPacket(PacketWithTime pwrt, SequenceContainer sc) processes packets derived from the given root container
void	resetStatistics()
void	setContainerListener(ContainerListener c)
void	setIgnoreOutOfContainerEntries(boolean ignoreOutOfContainerEntries) See XtceTmExtractor.setIgnoreOutOfContainerEntries(boolean)
void	setParameterListener(ParameterRequestManager p) Send parameters to this listener.
void	startProviding(Parameter param) Adds a parameter to the current subscription list: finds all the SequenceContainers in which this parameter may appear and adds them to the list.
void	startProviding(SequenceContainer container)
void	startProvidingAll() adds all parameters to the subscription
void	startProvidingAllContainers() Start providing all known containers
void	stopProviding(Parameter param) Removes a parameter from the list of parameters that have to be provided
void	stopProviding(SequenceContainer container)

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

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, 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 com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Field Detail

processor

public final Processor processor

xtcedb

public final XtceDb xtcedb

Constructor Detail

XtceTmProcessor

public XtceTmProcessor(Processor proc,
                       Map<String,Object> tmProcessorConfig)

XtceTmProcessor

public XtceTmProcessor(Processor proc)

XtceTmProcessor

public XtceTmProcessor(XtceDb xtcedb)

Creates a TmProcessor to be used in "standalone" mode, outside of any processor

Method Detail

setIgnoreOutOfContainerEntries

public void setIgnoreOutOfContainerEntries(boolean ignoreOutOfContainerEntries)

See XtceTmExtractor.setIgnoreOutOfContainerEntries(boolean)

Parameters:

ignoreOutOfContainerEntries -

init

public void init(Processor processor)
          throws ConfigurationException

Description copied from interface: ParameterProvider

Called before the startup to pass on the processor and initialize whatever needed

Specified by:

init in interface ParameterProvider

Throws:

ConfigurationException

setParameterListener

public void setParameterListener(ParameterRequestManager p)

Description copied from interface: ParameterProvider

Send parameters to this listener. Normally is the channel.parameterRequestManager but something different may be used for unit tests or special applications (PacketViewer)

Specified by:

setParameterListener in interface ParameterProvider

setContainerListener

public void setContainerListener(ContainerListener c)

Specified by:

setContainerListener in interface ContainerProvider

startProviding

public void startProviding(Parameter param)

Adds a parameter to the current subscription list: finds all the SequenceContainers in which this parameter may appear and adds them to the list. also for each sequence container adds the parameter needed to instantiate the sequence container.

Specified by:

startProviding in interface ParameterProvider

Parameters:

param - parameter to be added to the current subscription list

startProvidingAll

public void startProvidingAll()

adds all parameters to the subscription

Specified by:

startProvidingAll in interface ParameterProvider

stopProviding

public void stopProviding(Parameter param)

Description copied from interface: ParameterProvider

Removes a parameter from the list of parameters that have to be provided

Specified by:

stopProviding in interface ParameterProvider

canProvide

public boolean canProvide(Yamcs.NamedObjectId paraId)

Description copied from interface: ParameterProvider

Returns whether or not a given parameter can be provided by this provider

Specified by:

canProvide in interface ParameterProvider

Returns:

canProvide

public boolean canProvide(Parameter para)

Specified by:

canProvide in interface ParameterProvider

getParameter

public Parameter getParameter(Yamcs.NamedObjectId paraId)
                       throws InvalidIdentification

Description copied from interface: ParameterProvider

Returns the parameterDefinition corresponding to the parameter id

Specified by:

getParameter in interface ParameterProvider

Parameters:

paraId - - id of the parameter that is returned

Returns:

Throws:

InvalidIdentification

processPacket

public void processPacket(PacketWithTime pwrt)

Process telemetry packets

Specified by:

processPacket in interface TmSink

processPacket

public void processPacket(PacketWithTime pwrt,
                          SequenceContainer sc)

Description copied from interface: TmProcessor

processes packets derived from the given root container

Specified by:

processPacket in interface TmProcessor

finished

public void finished()

Description copied from interface: TmProcessor

Notification that there is no more packet to process

Specified by:

finished in interface TmProcessor

resetStatistics

public void resetStatistics()

getStatistics

public ProcessingStatistics getStatistics()

canProvideContainer

public boolean canProvideContainer(Yamcs.NamedObjectId containerId)

Description copied from interface: ContainerProvider

Returns whether or not a given container can be provided by this provider

Specified by:

canProvideContainer in interface ContainerProvider

startProviding

public void startProviding(SequenceContainer container)

Specified by:

startProviding in interface ContainerProvider

stopProviding

public void stopProviding(SequenceContainer container)

Specified by:

stopProviding in interface ContainerProvider

startProvidingAllContainers

public void startProvidingAllContainers()

Description copied from interface: ContainerProvider

Start providing all known containers

Specified by:

startProvidingAllContainers in interface ContainerProvider

getContainer

public Container getContainer(Yamcs.NamedObjectId containerId)
                       throws InvalidIdentification

Description copied from interface: ContainerProvider

Returns the containerDefinition corresponding to the itemId

Specified by:

getContainer in interface ContainerProvider

Throws:

InvalidIdentification

getSubscription

public Subscription getSubscription()

doStart

protected void doStart()

Specified by:

doStart in class com.google.common.util.concurrent.AbstractService

doStop

protected void doStop()

Specified by:

doStop in class com.google.common.util.concurrent.AbstractService

getXtceDb

public XtceDb getXtceDb()