DeltaPKnob (jmad-core API)

java.lang.Object
- cern.accsoft.steering.jmad.domain.knob.AbstractKnob
- - cern.accsoft.steering.jmad.model.knob.AbstractModelKnob
  - - cern.accsoft.steering.jmad.model.knob.custom.DeltaPKnob

All Implemented Interfaces:

Knob, ModelKnob
```
public class DeltaPKnob
extends AbstractModelKnob
```
This knob allows setting the x,y,px,py initial conditions according to the given deltap. This enforces the trajectory to match correctly the dispersion orbit.

Constructor Summary

Constructors
Constructor Description

DeltaPKnob(JMadModel model)

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getName()`
`double`	`getTotalValue()`
`KnobType`	`getType()`

Methods inherited from class cern.accsoft.steering.jmad.model.knob.AbstractModelKnob
getModel, setModel

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, toString, wait, wait, wait

Methods inherited from interface cern.accsoft.steering.jmad.domain.knob.Knob
addListener, getOffset, getValue, removeListener, setOffset, setValue

- Constructor Detail
  - DeltaPKnob
```
public DeltaPKnob(JMadModel model)
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    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()
```
    Returns:
    
    the total value (value+offset)
  - getKey
```
public java.lang.String getKey()
```
    Returns:
    
    a unique key (within all knobs of the same type)
  - getType
```
public KnobType getType()
```
    Returns:
    
    the type of this knob
  - getDescription
```
public java.lang.String getDescription()
```
    Returns:
    
    a description for this knob