Package org.yamcs.studio.script

Class Yamcs

java.lang.Object

org.yamcs.studio.script.Yamcs

public class Yamcs
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final Logger	log

Constructor Summary

Constructors

Constructor	Description
Yamcs()

Method Summary

Modifier and Type	Method	Description
static String	getMonitoringResult(IPV pv)	Returns the "monitoring result" of a Yamcs parameter.
static void	issueCommand(String commandText)	Sample use: Yamcs.issueCommand('/YSS/SIMULATOR/SWITCH_VOLTAGE_ON(voltage_num: 1)');
static void	issueCommand(String command, Map<String,Object> args)	Sample use: Yamcs.issueCommand('/YSS/SIMULATOR/SWITCH_VOLTAGE_ON', {"voltage_num": 1});
static void	runCommandStack(String path)
static void	runCommandStack(String path, AbstractBaseEditPart widget)
static void	runProcedure(String procedure)	Submit a SPELL procedure.
static void	runProcedure(String procedure, Map<String,Object> args)	Submit a SPELL procedure with arguments.
static void	writeTextFileToBucket(String bucket, String objectName, String text)	Write a text file to a bucket.

Methods inherited from class java.lang.Object

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

Field Details

log

public static final Logger log

Constructor Details

Yamcs

public Yamcs()

Method Details

issueCommand

public static void issueCommand(String commandText)

Sample use: Yamcs.issueCommand('/YSS/SIMULATOR/SWITCH_VOLTAGE_ON(voltage_num: 1)');

issueCommand

public static void issueCommand(String command,
 Map<String,Object> args)

Sample use: Yamcs.issueCommand('/YSS/SIMULATOR/SWITCH_VOLTAGE_ON', {"voltage_num": 1});

runCommandStack

public static void runCommandStack(String path)

runCommandStack

public static void runCommandStack(String path,
 AbstractBaseEditPart widget)

runProcedure

public static void runProcedure(String procedure)

Submit a SPELL procedure.

Only useful when the connected Yamcs backend supports this (not publicly released).

runProcedure

public static void runProcedure(String procedure,
 Map<String,Object> args)

Submit a SPELL procedure with arguments.

Only useful when the connected Yamcs backend supports this (not publicly released).

getMonitoringResult

public static String getMonitoringResult(IPV pv)

Returns the "monitoring result" of a Yamcs parameter. One of IN_LIMITS, DISABLED, WATCH, WARNING, DISTRESS, CRITICAL or SEVERE.

For PVs that are not connected to Yamcs parameters, this will always return null.

writeTextFileToBucket

public static void writeTextFileToBucket(String bucket,
 String objectName,
 String text)

Write a text file to a bucket.

Sample use: Yamcs.writeTextFileToBucket("bucketName", "some/file.txt", "Hello!\n");

Parameters:

bucket - target bucket.

objectName - target object name.

text - the text to be written to the object.