xal.sim.slg

Class Dipole

java.lang.Object

xal.sim.slg.Element

xal.sim.slg.Dipole

All Implemented Interfaces:

java.lang.Cloneable, VisitorListener

public class Dipole
extends Element

The dipole element (a thick element).

Nested Class Summary

Nested classes/interfaces inherited from class xal.sim.slg.Element

Element.SECTION

Field Summary

Fields inherited from class xal.sim.slg.Element

fmt, handleAsThick

Constructor Summary

Constructors

Constructor and Description
Dipole(double position, double len) Creates a new instance of Dipole
Dipole(java.lang.Double position, java.lang.Double len) Creates a new instance of Dipole
Dipole(double position, double len, java.lang.String name) Creates a new instance of Dipole
Dipole(java.lang.Double position, java.lang.Double len, java.lang.String name) Creates a new instance of Dipole
Dipole(Element.SECTION secHware, double position, double len, java.lang.String name) Create a new, initialized Dipole object.

Method Summary

Modifier and Type	Method and Description
void	accept(Visitor v) When called with a Visitor reference the implementor can either reject to be visited (empty method body) or call the Visitor by passing its own object reference.
java.lang.String	getType() Return the element type.

Methods inherited from class xal.sim.slg.Element

clone, getAcceleratorNode, getBase, getEndPosition, getFam, getHardwareSection, getLength, getName, getPosition, getStartPosition, isThick, setAcceleratorNode, setBase, setHardwareSection, setLength, setPosition, split, toAbsolutePosition, toCoutString, version

Methods inherited from class java.lang.Object

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

Constructor Detail

Dipole

public Dipole(Element.SECTION secHware,
              double position,
              double len,
              java.lang.String name)

Create a new, initialized Dipole object.

Parameters:

secHware - element's corresponding hardware component

position - element position within the lattice

len - element length

name - string identifier for element

Since:

Sep 2, 2009

Dipole

public Dipole(double position,
              double len,
              java.lang.String name)

Creates a new instance of Dipole

Dipole

public Dipole(java.lang.Double position,
              java.lang.Double len,
              java.lang.String name)

Creates a new instance of Dipole

Dipole

public Dipole(double position,
              double len)

Creates a new instance of Dipole

Dipole

public Dipole(java.lang.Double position,
              java.lang.Double len)

Creates a new instance of Dipole

Method Detail

getType

public java.lang.String getType()

Description copied from class: Element

Return the element type.

Specified by:

getType in class Element

accept

public void accept(Visitor v)

When called with a Visitor reference the implementor can either reject to be visited (empty method body) or call the Visitor by passing its own object reference.

Specified by:

accept in interface VisitorListener

Specified by:

accept in class Element

Parameters:

v - the Visitor which wants to visit this object.