org.yamcs.algorithms

Class AlgorithmUtils

java.lang.Object

org.yamcs.algorithms.AlgorithmUtils

public class AlgorithmUtils
extends Object

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

The java method AlgorithmUtils.[method] is available in scripts as Yamcs.[method]

Constructor Summary

Constructors

Constructor and Description
AlgorithmUtils(String yamcsInstance, ProcessorData processorData, Processor processor, XtceDb xtcedb, String algorithmName)

Method Summary

Modifier and Type	Method and Description
Object	calibrate(int raw, String parameter) Calibrate raw value according to the calibration rule of the given parameter
void	error(String msg)
void	error(String type, String msg)
void	info(String msg)
void	info(String type, String msg)
String	instance()
long	letohl(int value) Little endian to host long
String	processorName() returns the processor name if the algorithm is running in a processor or null otherwise
void	warning(String msg)
void	warning(String type, String msg)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmUtils

public AlgorithmUtils(String yamcsInstance,
                      ProcessorData processorData,
                      Processor processor,
                      XtceDb xtcedb,
                      String algorithmName)

Method Detail

calibrate

public Object calibrate(int raw,
                        String parameter)

Calibrate raw value according to the calibration rule of the given parameter

Returns:

a Float or String object

instance

public String instance()

info

public void info(String msg)

info

public void info(String type,
                 String msg)

warning

public void warning(String msg)

warning

public void warning(String type,
                    String msg)

error

public void error(String msg)

error

public void error(String type,
                  String msg)

processorName

public String processorName()

returns the processor name if the algorithm is running in a processor or null otherwise

Returns:

letohl

public long letohl(int value)

Little endian to host long