Package org.yamcs.algorithms

Class VerifierFunctions

java.lang.Object

org.yamcs.algorithms.VerifierFunctions

public class VerifierFunctions
extends Object

Library of functions available from within Algorithm scripts using this naming scheme:

The java method VerifierFunctions.[method] is available in scripts as Verifier.[method]

Constructor Summary

Constructors

Constructor	Description
VerifierFunctions()

Method Summary

Modifier and Type	Method	Description
VerificationResult	createResult(boolean success)	Create a new verification result
VerificationResult	failure()	Returns a failed verification result
VerificationResult	failure(String message)	Returns a failed verification result with provided message
VerificationResult	failure(String message, Object value)	Returns a failed verification result with provided message, and a return value
VerificationResult	success()	Returns a successful verification result
VerificationResult	success(String message)	Returns a successful verification result with provided message
VerificationResult	success(String message, Object value)	Returns a successful verification result with provided message, and a return value

Methods inherited from class java.lang.Object

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

Constructor Details

VerifierFunctions

public VerifierFunctions()

Method Details

success

public VerificationResult success()

Returns a successful verification result

success

public VerificationResult success(String message)

Returns a successful verification result with provided message

success

public VerificationResult success(String message,
 Object value)

Returns a successful verification result with provided message, and a return value

failure

public VerificationResult failure()

Returns a failed verification result

failure

public VerificationResult failure(String message)

Returns a failed verification result with provided message

failure

public VerificationResult failure(String message,
 Object value)

Returns a failed verification result with provided message, and a return value

createResult

public VerificationResult createResult(boolean success)

Create a new verification result