Package cern.accsoft.steering.jmad.domain.knob.strength

Class SimpleStrength

java.lang.Object

cern.accsoft.steering.jmad.domain.knob.AbstractKnob

cern.accsoft.steering.jmad.domain.knob.strength.SimpleStrength

All Implemented Interfaces:

Knob, MadxParameter, Strength

public class SimpleStrength
extends AbstractKnob
implements Strength

Constructor Summary

Constructors

Constructor	Description
SimpleStrength(java.lang.String name, double value, java.lang.String comment)

Method Summary

Modifier and Type	Method	Description
protected void	doSetTotalValue(double value)	has to be implemented by subclass to set the total value to madx.
java.lang.String	getDescription()
java.lang.String	getKey()
java.lang.String	getMadxName()
java.lang.String	getName()
double	getTotalValue()
KnobType	getType()
void	setDescription(java.lang.String description)
java.lang.String	toString()

Methods inherited from class cern.accsoft.steering.jmad.domain.knob.AbstractKnob

addListener, getOffset, getValue, removeListener, setOffset, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface cern.accsoft.steering.jmad.domain.knob.Knob

addListener, getOffset, getValue, removeListener, setOffset, setValue

Constructor Detail

SimpleStrength

public SimpleStrength(java.lang.String name,
                      double value,
                      java.lang.String comment)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface Knob

Returns:

the name of the knob

doSetTotalValue

protected void doSetTotalValue(double value)

Description copied from class: AbstractKnob

has to be implemented by subclass to set the total value to madx. The only call from this is from setTotalValue, which also notifies the listeners.

Specified by:

doSetTotalValue in class AbstractKnob

Parameters:

value - the value to set

getTotalValue

public double getTotalValue()

Specified by:

getTotalValue in interface Knob

Returns:

the total value (value+offset)

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Knob

Returns:

a description for this knob

setDescription

public void setDescription(java.lang.String description)

getKey

public java.lang.String getKey()

Specified by:

getKey in interface Knob

Returns:

a unique key (within all knobs of the same type)

getType

public KnobType getType()

Specified by:

getType in interface Knob

Returns:

the type of this knob

getMadxName

public java.lang.String getMadxName()

Specified by:

getMadxName in interface MadxParameter

Returns:

the name to be used in madx

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object