org.yamcs

Class Processor

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.Processor

All Implemented Interfaces:

com.google.common.util.concurrent.Service

public class Processor
extends com.google.common.util.concurrent.AbstractService

This class helps keeping track of the different objects used in a Yamcs Processor - i.e. all the objects required to have a TM/TC processing chain (either realtime or playback).

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

Constructor Summary

Constructors

Constructor and Description
Processor(String yamcsInstance, String name, String type, String creator)

Method Summary

Modifier and Type	Method and Description
static void	addProcessorListener(ProcessorListener processorListener)
void	changeSpeed(Yamcs.ReplaySpeed speed)
void	connect(ProcessorClient s) Increase with one the number of connected clients
static Processor	connect(String yamcsInstance, String name, ProcessorClient s) Increase with one the number of connected clients to the named processor and return the processor.
void	disconnect(ProcessorClient s) Disconnects a client from this processor.
void	doStart() starts processing by invoking the start method for all the associated components
void	doStop() Closes the processor by stoping the tm/pp and tc It can be that there are still clients connected, but they will not get any data and new clients can not connect to these processors anymore.
static List<String>	getAllProcessors() returns a list of all processors names
CommandHistoryRequestManager	getCommandHistoryManager()
CommandHistoryPublisher	getCommandHistoryPublisher()
CommandingManager	getCommandingManager()
CommandReleaser	getCommandReleaser()
int	getConnectedClients()
ContainerRequestManager	getContainerRequestManager()
String	getCreator()
long	getCurrentTime() Returns the processor time for realtime processors it is the mission time or simulation time for replay processors it is the replay time
ExecutorService	getExecutor()
static Processor	getFirstProcessor(String yamcsInstance) Returns the first register processor for the given instance or null if there is no processor registered.
String	getInstance()
static Processor	getInstance(String yamcsInstance, String name)
String	getName()
ParameterCacheConfig	getPameterCacheConfig()
ParameterCache	getParameterCache()
ParameterRequestManager	getParameterRequestManager()
ProcessorData	getProcessorData() Returns the processor data used to store processor specific calibration, alarms
static Collection<Processor>	getProcessors()
static Collection<Processor>	getProcessors(String instance)
Yamcs.ReplayRequest	getReplayRequest() valid only if isArchiveReplay returns true
Yamcs.ReplayStatus.ReplayState	getReplayState() valid only if isArchiveReplay returns true
List<ServiceWithConfig>	getServices()
YamcsManagement.ServiceState	getState()
ScheduledThreadPoolExecutor	getTimer()
TmPacketProvider	getTmPacketProvider()
XtceTmProcessor	getTmProcessor()
String	getType()
XtceDb	getXtceDb()
boolean	hasAlarmChecker()
boolean	hasAlarmServer()
boolean	hasCommanding()
boolean	isPersistent()
boolean	isReplay()
boolean	isSynchronous()
void	notifyStateChange()
void	pause()
void	quit()
static void	removeProcessorListener(ProcessorListener processorListener)
void	resume()
void	seek(long instant)
void	setCommandHistoryProvider(CommandHistoryProvider chp)
void	setCommandReleaser(CommandReleaser cr)
void	setCreator(String creator)
void	setPacketProvider(TmPacketProvider tpp)
void	setPersistent(boolean systemSession)
void	setSynchronous(boolean synchronous)
void	start()
String	toString()

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

addListener, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

Processor

public Processor(String yamcsInstance,
                 String name,
                 String type,
                 String creator)
          throws ProcessorException

Throws:

ProcessorException

Method Detail

setPacketProvider

public void setPacketProvider(TmPacketProvider tpp)

setCommandReleaser

public void setCommandReleaser(CommandReleaser cr)

setCommandHistoryProvider

public void setCommandHistoryProvider(CommandHistoryProvider chp)

getExecutor

public ExecutorService getExecutor()

getCommandHistoryPublisher

public CommandHistoryPublisher getCommandHistoryPublisher()

getParameterRequestManager

public ParameterRequestManager getParameterRequestManager()

getContainerRequestManager

public ContainerRequestManager getContainerRequestManager()

getTmProcessor

public XtceTmProcessor getTmProcessor()

doStart

public void doStart()

starts processing by invoking the start method for all the associated components

Specified by:

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

getServices

public List<ServiceWithConfig> getServices()

pause

public void pause()

resume

public void resume()

seek

public void seek(long instant)

changeSpeed

public void changeSpeed(Yamcs.ReplaySpeed speed)

getCommandReleaser

public CommandReleaser getCommandReleaser()

Returns:

the tcUplinker

getTmPacketProvider

public TmPacketProvider getTmPacketProvider()

Returns:

the tmPacketProvider

getName

public String getName()

getType

public String getType()

Returns:

the type

getCreator

public String getCreator()

setCreator

public void setCreator(String creator)

getConnectedClients

public int getConnectedClients()

getInstance

public static Processor getInstance(String yamcsInstance,
                                    String name)

getFirstProcessor

public static Processor getFirstProcessor(String yamcsInstance)

Returns the first register processor for the given instance or null if there is no processor registered.

Parameters:

yamcsInstance - - instance name for which the processor has to be returned.

Returns:

the first registered processor for the given instance

connect

public static Processor connect(String yamcsInstance,
                                String name,
                                ProcessorClient s)
                         throws ProcessorException

Increase with one the number of connected clients to the named processor and return the processor.

Parameters:

yamcsInstance -

name -

s -

Returns:

the processor with the given name

Throws:

ProcessorException

connect

public void connect(ProcessorClient s)
             throws ProcessorException

Increase with one the number of connected clients

Throws:

ProcessorException

disconnect

public void disconnect(ProcessorClient s)

Disconnects a client from this processor. If the processor has no more clients, quit.

getProcessors

public static Collection<Processor> getProcessors()

getProcessors

public static Collection<Processor> getProcessors(String instance)

doStop

public void doStop()

Closes the processor by stoping the tm/pp and tc It can be that there are still clients connected, but they will not get any data and new clients can not connect to these processors anymore. Once it is closed, you can create a processor with the same name which will make it maybe a bit confusing :(

Specified by:

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

addProcessorListener

public static void addProcessorListener(ProcessorListener processorListener)

removeProcessorListener

public static void removeProcessorListener(ProcessorListener processorListener)

isPersistent

public boolean isPersistent()

setPersistent

public void setPersistent(boolean systemSession)

isSynchronous

public boolean isSynchronous()

hasCommanding

public boolean hasCommanding()

setSynchronous

public void setSynchronous(boolean synchronous)

isReplay

public boolean isReplay()

getReplayRequest

public Yamcs.ReplayRequest getReplayRequest()

valid only if isArchiveReplay returns true

Returns:

getReplayState

public Yamcs.ReplayStatus.ReplayState getReplayState()

valid only if isArchiveReplay returns true

Returns:

getState

public YamcsManagement.ServiceState getState()

getCommandingManager

public CommandingManager getCommandingManager()

toString

public String toString()

Overrides:

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

getInstance

public String getInstance()

Returns:

the yamcs instance this processor is part of

getXtceDb

public XtceDb getXtceDb()

getCommandHistoryManager

public CommandHistoryRequestManager getCommandHistoryManager()

hasAlarmChecker

public boolean hasAlarmChecker()

hasAlarmServer

public boolean hasAlarmServer()

getTimer

public ScheduledThreadPoolExecutor getTimer()

getCurrentTime

public long getCurrentTime()

Returns the processor time for realtime processors it is the mission time or simulation time for replay processors it is the replay time

Returns:

quit

public void quit()

start

public void start()

notifyStateChange

public void notifyStateChange()

getAllProcessors

public static List<String> getAllProcessors()

returns a list of all processors names

Returns:

all processors names as a list of instance.processorName

getPameterCacheConfig

public ParameterCacheConfig getPameterCacheConfig()

getParameterCache

public ParameterCache getParameterCache()

getProcessorData

public ProcessorData getProcessorData()

Returns the processor data used to store processor specific calibration, alarms

Returns:

processor specific data