Package org.yamcs.xtce

Class Algorithm

java.lang.Object

org.yamcs.xtce.NameDescription

org.yamcs.xtce.Algorithm

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CustomAlgorithm, MathAlgorithm

public abstract class Algorithm
extends NameDescription

Abstract algorithm - just defines the inputs, outputs and triggers Note: the XTCE names the inputs and outputs "Sets". However we use them as lists not

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Algorithm.Scope

Nested classes/interfaces inherited from class org.yamcs.xtce.NameDescription

NameDescription.Builder<T extends NameDescription.Builder<T>>

Field Summary

Fields inherited from class org.yamcs.xtce.NameDescription

ancillaryData, name, PATH_SEPARATOR, qualifiedName, xtceAliasSet

Constructor Summary

Constructors

Constructor	Description
Algorithm(String name)

Method Summary

Modifier and Type	Method	Description
void	addInput(InputParameter inputParameter)
void	addOutput(OutputParameter outputParameter)
boolean	canProvide(Parameter parameter)
List<InputParameter>	getInputList()	Returns the list of input parameters
List<InputParameter>	getInputSet()	same as getInputList(), although it's a list this method calls it Set due to XTCE terminology.
List<OutputParameter>	getOutputList()
List<OutputParameter>	getOutputSet()	same as getOutputList(), although it's a list this method calls it Set due to XTCE terminology.
Algorithm.Scope	getScope()
TriggerSetType	getTriggerSet()
void	print(PrintStream out)
void	setInputList(List<InputParameter> inputList)
void	setInputSet(List<InputParameter> inputSet)
void	setOutputList(List<OutputParameter> outputList)
void	setOutputSet(List<OutputParameter> outputSet)
void	setScope(Algorithm.Scope scope)
void	setTriggerSet(TriggerSetType triggerSet)

Methods inherited from class org.yamcs.xtce.NameDescription

addAlias, addAliases, addAncillaryData, getAlias, getAliasSet, getAncillaryData, getLongDescription, getName, getName, getOpsName, getQualifiedName, getShortDescription, getSubsystemName, getSubsystemName, setAliasSet, setAncillaryData, setLongDescription, setName, setQualifiedName, setShortDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

Algorithm

public Algorithm(String name)

Method Detail

getTriggerSet

public TriggerSetType getTriggerSet()

setTriggerSet

public void setTriggerSet(TriggerSetType triggerSet)

addInput

public void addInput(InputParameter inputParameter)

addOutput

public void addOutput(OutputParameter outputParameter)

getInputSet

public List<InputParameter> getInputSet()

same as getInputList(), although it's a list this method calls it Set due to XTCE terminology.

Returns:

ordered list of input parameters

getInputList

public List<InputParameter> getInputList()

Returns the list of input parameters

Returns:

getOutputSet

public List<OutputParameter> getOutputSet()

same as getOutputList(), although it's a list this method calls it Set due to XTCE terminology.

Returns:

getOutputList

public List<OutputParameter> getOutputList()

Returns:

ordered list of output parameters

setOutputSet

public void setOutputSet(List<OutputParameter> outputSet)

setOutputList

public void setOutputList(List<OutputParameter> outputList)

setInputSet

public void setInputSet(List<InputParameter> inputSet)

setInputList

public void setInputList(List<InputParameter> inputList)

canProvide

public boolean canProvide(Parameter parameter)

getScope

public Algorithm.Scope getScope()

setScope

public void setScope(Algorithm.Scope scope)

print

public void print(PrintStream out)