Package org.yamcs.xtce

Class CommandVerifier

java.lang.Object

org.yamcs.xtce.CommandVerifier

All Implemented Interfaces:

Serializable

public class CommandVerifier
extends Object
implements Serializable

XTCE: A command verifier is used to check that the command has been successfully executed.

Command Verifiers may be either a Custom Algorithm or a Boolean Check or the presence of a Container for a relative change in the value of a Parameter.

The CheckWindow is a time period where the verification must test true to pass.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CommandVerifier.TerminationAction	what can happen when the verification finishes XTCE does not specify very well, just that each verifier returns true or false.
static enum	CommandVerifier.Type

Constructor Summary

Constructors

Constructor	Description
CommandVerifier(CommandVerifier cv)
CommandVerifier(CommandVerifier.Type type, String stage)
CommandVerifier(CommandVerifier.Type type, String stage, CheckWindow checkWindow)

Method Summary

Modifier and Type	Method	Description
boolean	failOnFirstFailedMatch()
Algorithm	getAlgorithm()
CheckWindow	getCheckWindow()
SequenceContainer	getContainerRef()
List<Parameter>	getDependentParameters()
MatchCriteria	getMatchCriteria()
CommandVerifier.TerminationAction	getOnFail()
CommandVerifier.TerminationAction	getOnSuccess()
CommandVerifier.TerminationAction	getOnTimeout()
ParameterValueChange	getParameterValueChange()
Parameter	getReturnParameter()
String	getStage()
CommandVerifier.Type	getType()
void	setAlgorithm(Algorithm algo)
void	setCheckWindow(CheckWindow checkWindow)
void	setContainerRef(SequenceContainer containerRef)
void	setMatchCriteria(MatchCriteria matchCriteria)
void	setOnFail(CommandVerifier.TerminationAction onFail)
void	setOnSuccess(CommandVerifier.TerminationAction onSuccess)
void	setOnTimeout(CommandVerifier.TerminationAction onTimeout)
void	setParameterValueChange(ParameterValueChange paraValueChange)
void	setReturnParameter(Parameter returnParameter)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CommandVerifier

public CommandVerifier(CommandVerifier.Type type,
 String stage)

CommandVerifier

public CommandVerifier(CommandVerifier.Type type,
 String stage,
 CheckWindow checkWindow)

CommandVerifier

public CommandVerifier(CommandVerifier cv)

Method Details

getStage

public String getStage()

getType

public CommandVerifier.Type getType()

setContainerRef

public void setContainerRef(SequenceContainer containerRef)

getContainerRef

public SequenceContainer getContainerRef()

getAlgorithm

public Algorithm getAlgorithm()

setAlgorithm

public void setAlgorithm(Algorithm algo)

setMatchCriteria

public void setMatchCriteria(MatchCriteria matchCriteria)

getCheckWindow

public CheckWindow getCheckWindow()

getOnTimeout

public CommandVerifier.TerminationAction getOnTimeout()

setOnTimeout

public void setOnTimeout(CommandVerifier.TerminationAction onTimeout)

getOnFail

public CommandVerifier.TerminationAction getOnFail()

setCheckWindow

public void setCheckWindow(CheckWindow checkWindow)

setOnFail

public void setOnFail(CommandVerifier.TerminationAction onFail)

getOnSuccess

public CommandVerifier.TerminationAction getOnSuccess()

setOnSuccess

public void setOnSuccess(CommandVerifier.TerminationAction onSuccess)

getMatchCriteria

public MatchCriteria getMatchCriteria()

getParameterValueChange

public ParameterValueChange getParameterValueChange()

setParameterValueChange

public void setParameterValueChange(ParameterValueChange paraValueChange)

failOnFirstFailedMatch

public boolean failOnFirstFailedMatch()

getReturnParameter

public Parameter getReturnParameter()

setReturnParameter

public void setReturnParameter(Parameter returnParameter)

getDependentParameters

public List<Parameter> getDependentParameters()

toString

public String toString()

Overrides:

toString in class Object