Package org.yamcs.algorithms

Class AlgorithmFunctions

java.lang.Object

org.yamcs.algorithms.AlgorithmFunctions

public class AlgorithmFunctions
extends Object

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

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

Constructor Summary

Constructors

Constructor	Description
AlgorithmFunctions(Processor processor)

Method Summary

Modifier and Type	Method	Description
Object	calibrate(int raw, String parameter)	Calibrate raw value according to the calibration rule of the given parameter
void	critical(String msg)
void	critical(String type, String msg)
void	critical(String source, String type, String msg)
void	distress(String msg)
void	distress(String type, String msg)
void	distress(String source, 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	severe(String msg)
void	severe(String type, String msg)
void	severe(String source, String type, String msg)
void	warning(String msg)
void	warning(String type, String msg)
void	warning(String source, String type, String msg)
void	watch(String msg)
void	watch(String type, String msg)
void	watch(String source, String type, String msg)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlgorithmFunctions

public AlgorithmFunctions(Processor processor)

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)

watch

public void watch(String msg)

watch

public void watch(String type,
                  String msg)

watch

public void watch(String source,
                  String type,
                  String msg)

warning

public void warning(String msg)

warning

public void warning(String type,
                    String msg)

warning

public void warning(String source,
                    String type,
                    String msg)

distress

public void distress(String msg)

distress

public void distress(String type,
                     String msg)

distress

public void distress(String source,
                     String type,
                     String msg)

critical

public void critical(String msg)

critical

public void critical(String type,
                     String msg)

critical

public void critical(String source,
                     String type,
                     String msg)

severe

public void severe(String msg)

severe

public void severe(String type,
                   String msg)

severe

public void severe(String source,
                   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