stella

Interface CommandRendering

All Superinterfaces:

GlobalDepending, PropertySupplying, TargetDepending

All Known Implementing Classes:

AbstractCommandRenderer, XMLRenderer

public interface CommandRendering
extends PropertySupplying, GlobalDepending, TargetDepending

An interface that allows the rendering of fully qualified commands from command templates. Implementations of this interface are used as an intermediate layer to translate command templates used for generally describing an observing sequence (Sequencing) into ready-to-use CommandEvents to pass to the command servers.

This interface will always require information on the actual target as well as the actual hardware configuration. It is the most common place for adapting the entrie SCS system for different hardware.

Field Summary

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Method Summary

Modifier and Type	Method and Description
CommandEvent	getFullCommand(String template, String id, String parameter, String init, Map<String,Object> seq) Retrieves a fully qualified command from a command template.
GlobalGrouping	getParameterCluster() Returns the parameter cluster registered at this renderer.
TargetDefinition	getTarget() Returns the target registered to this renderer.

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Methods inherited from interface globals.GlobalDepending

registerGlobals

Methods inherited from interface target.TargetDepending

registerTarget

Method Detail

getTarget

TargetDefinition getTarget()

Returns the target registered to this renderer.

getParameterCluster

GlobalGrouping getParameterCluster()

Returns the parameter cluster registered at this renderer.

getFullCommand

CommandEvent getFullCommand(String template,
                            String id,
                            String parameter,
                            String init,
                            Map<String,Object> seq)

Retrieves a fully qualified command from a command template. Should throw an Illegal Argument Exception if the template cannot be rendered into a command. If no target has been registered to this command renderer an Illegal Thread State Exception, which is a subclass of an Illegal Argument Exception should be thrown.
As command rendering sometimes may be subject to the current observing conditions, all relevant parameters may be handed over. This may apply to targets, where e.g. a star is picked out of a list of possible choices, depending on the current sidereal time.

Parameters:

template - The command template, equal the command type.

id - An id further specializing the command template.

parameter - The name of the parameters as a comma-separated list.

init - A static initializer to the command or null.

seq - A lookup-table with values from the sequencer, like counters.