stella.command

Class SelectFilterCalibration

java.lang.Object

java.util.EventObject

util.rmi.RmiEvent

stella.MessageEvent

stella.CommandEvent

stella.command.SelectFilterCalibration

All Implemented Interfaces:

ParameterDepending, Serializable, CalibrationCommand, InitializerDepending, TargetDependingCommand

Direct Known Subclasses:

SelectClearFilterCalibration, SelectInitFilterCalibration

public class SelectFilterCalibration
extends CommandEvent
implements CalibrationCommand, TargetDependingCommand, InitializerDepending, ParameterDepending

The select filter adapter command. The filter name is provided as a constant in a ParsedTarget.Setup object, named with ReserverdConstants#FILTER. This constant should be a string. It is within the responsiblity of the adapter to translate the filter name to filter wheel position(s).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class stella.CommandEvent

CommandEvent.Create

Field Summary

Fields

Modifier and Type	Field and Description
private String	filter The desired filter name.
private boolean	zero If true, do zero-positioning before.

Fields inherited from class stella.CommandEvent

COMMANDPACKAGE, JVIEWPACKAGE, TYPESEPARATOR

Fields inherited from class stella.MessageEvent

SEPCHAR

Fields inherited from class util.rmi.RmiEvent

localHost, sourceName

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
SelectFilterCalibration(Object src) Constructs a select filter adapter, grabbing the type from the class name and setting the command time to the current system time.
SelectFilterCalibration(Object src, String type, long time) Constructs a select filter command.

Method Summary

Modifier and Type	Method and Description
String	getFilter() Returns the required filter name.
String[]	getLine() Returns the command line of the select filter command.
boolean	getZero()
void	initWith(String focus) Used for a default setting if the target does not provide a filter.
boolean	parseLine(String[] all) Parse the command line into filter name of the select filter command.
void	registerParameter(Parameter p) A parameter depending command should drain the necessarry information to get valid out of a parameter value.
void	registerTargetProperties(Object color) Calculates the command line from the mapping delivered in the DTDConstants.SETUP DOM-element.
protected void	setFilter(String f) Daughter access possible for setting the filter.

Methods inherited from class stella.CommandEvent

classNameToTemplate, createCommand, createCommand, createJCommand, extractType, getExpectedAcknowledgeNumber, parseForStrings, templateToClassName

Methods inherited from class stella.MessageEvent

checkType, equals, equalTime, equalTime, fromAscii, getAllCommandLines, getExecuteGroupKey, getHead, getNr, getTime, getType, hashCode, isValid, parseFromSingleString, readFromBufferedStream, setNr, setTime, setType, setValid, toSkippedString, toString

Methods inherited from class util.rmi.RmiEvent

getHost, getSourceName, setSourceName

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

filter

private String filter

The desired filter name.

zero

private boolean zero

If true, do zero-positioning before.

Constructor Detail

SelectFilterCalibration

public SelectFilterCalibration(Object src)

Constructs a select filter adapter, grabbing the type from the class name and setting the command time to the current system time.

SelectFilterCalibration

public SelectFilterCalibration(Object src,
                               String type,
                               long time)

Constructs a select filter command. Only the header is fully qualified with the provided argumnets. The command line can only be retrieved after a DTDConstants.SETUP element has been registered to this command.

See Also:

MessageEvent.isValid()

Method Detail

initWith

public void initWith(String focus)

Used for a default setting if the target does not provide a filter.

Specified by:

initWith in interface InitializerDepending

registerParameter

public void registerParameter(Parameter p)

Description copied from interface: ParameterDepending

A parameter depending command should drain the necessarry information to get valid out of a parameter value. During rendering, parameter depending commands should receive their data through this method. Note that it is always possible to pile up all the information needed for a single command in a single parameter.

Specified by:

registerParameter in interface ParameterDepending

registerTargetProperties

public void registerTargetProperties(Object color)

Calculates the command line from the mapping delivered in the DTDConstants.SETUP DOM-element. It uses the filter name stored in the setup section handed over.

Specified by:

registerTargetProperties in interface TargetDependingCommand

getLine

public String[] getLine()

Returns the command line of the select filter command.

Specified by:

getLine in class MessageEvent

Returns:

An array containing all command lines.

parseLine

public boolean parseLine(String[] all)

Parse the command line into filter name of the select filter command.

Specified by:

parseLine in class MessageEvent

Returns:

True, if parsing was successful.

getFilter

public String getFilter()

Returns the required filter name.

getZero

public boolean getZero()

Returns:

True, if zero-positioning was requested.

setFilter

protected void setFilter(String f)

Daughter access possible for setting the filter.