java.lang.Object
org.yamcs.xtce.CommandVerifier
- All Implemented Interfaces:
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
what can happen when the verification finishes XTCE does not specify very well, just that each verifier returns true or false.static enum
-
Constructor Summary
ConstructorDescriptionCommandVerifier
(CommandVerifier.Type type, String stage) CommandVerifier
(CommandVerifier.Type type, String stage, CheckWindow checkWindow) -
Method Summary
Modifier and TypeMethodDescriptionboolean
getStage()
getType()
void
setAlgorithm
(Algorithm algo) void
setCheckWindow
(CheckWindow checkWindow) void
setContainerRef
(SequenceContainer containerRef) void
setMatchCriteria
(MatchCriteria matchCriteria) void
void
setOnSuccess
(CommandVerifier.TerminationAction onSuccess) void
setOnTimeout
(CommandVerifier.TerminationAction onTimeout) void
setParameterValueChange
(ParameterValueChange paraValueChange) void
setReturnParameter
(Parameter returnParameter) toString()
-
Constructor Details
-
CommandVerifier
-
CommandVerifier
-
CommandVerifier
-
-
Method Details
-
getStage
-
getType
-
setContainerRef
-
getContainerRef
-
getAlgorithm
-
setAlgorithm
-
setMatchCriteria
-
getCheckWindow
-
getOnTimeout
-
setOnTimeout
-
getOnFail
-
setCheckWindow
-
setOnFail
-
getOnSuccess
-
setOnSuccess
-
getMatchCriteria
-
getParameterValueChange
-
setParameterValueChange
-
failOnFirstFailedMatch
public boolean failOnFirstFailedMatch() -
getReturnParameter
-
setReturnParameter
-
getDependentParameters
-
toString
-