Package org.scictrl.mp.orbitcorrect.model.optics

Class Marker

java.lang.Object

org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

org.scictrl.mp.orbitcorrect.model.optics.Marker

All Implemented Interfaces:

Cloneable, ISimpleElement

public class Marker
extends AbstractOpticalElement

This type does not represent the actual element. It is inducted only to one mark position, where we can read machine functions, calculate length from one to another position an so on. It can be placed inside other element. Markers are also often used to marking points of simmetry.

Author:

igor@scictrl.com

Field Summary

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

PR_POSITION, PR_REL_FROM, PR_REL_POSITION

Fields inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

lastActionResult, owner, PR_ELEMENT_NAME, PR_VIRTUAL

Constructor Summary

Constructors

Constructor	Description
Marker(String name)	Marker constructor, which request only name.
Marker(String name, boolean virtual, double position, double relpos, String relFrom)	Marker constructor, that request specified parameters:

Method Summary

Modifier and Type	Method	Description
DBElementDescriptor	descriptor()	Returns the descriptor object for this element.
int	elType()	Returns the code of element's type.
void	setWith(Object[] par)	Sets parameters values of this element to those in parameter array.
String	toString()	Returns the string representation of this element.

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractOpticalElement

clone, getAlpha, getBeta, getDispersion, getIndex, getPosition, getQ, getRelFrom, getRelPosition, setPosition, setRelFrom, setRelPosition

Methods inherited from class org.scictrl.mp.orbitcorrect.model.optics.AbstractDataBushElement

equals, getLastActionResult, getName, getOwner, getVirtual, hashCode, isInitialized, isVirtual, setVirtual, throwISE

Methods inherited from class java.lang.Object

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

Constructor Details

Marker

public Marker(String name)

Marker constructor, which request only name.

Parameters:

name - a String object

Marker

public Marker(String name,
 boolean virtual,
 double position,
 double relpos,
 String relFrom)

Marker constructor, that request specified parameters:

Parameters:

name - a String object

virtual - a boolean

position - a double

relpos - a double

relFrom - a String object

Method Details

descriptor

public DBElementDescriptor descriptor()

Returns the descriptor object for this element. DBElementDescriptor helps manipulating DataBush elements dynamically.

descriptor.

Specified by:

descriptor in class AbstractDataBushElement

Returns:

the descriptor object for this element.

See Also:

• AbstractDataBushElement.descriptor()

elType

public int elType()

Returns the code of element's type.

elType.

Specified by:

elType in class AbstractDataBushElement

Returns:

the code of element's type.

See Also:

• AbstractDataBushElement.elType()

setWith

public void setWith(Object[] par)
             throws IllegalStateException

Sets parameters values of this element to those in parameter array. As parameter must be used such array as for dynamical construction of new instance of this class. Current values are overriden for each not null object in array.

setWith.

setWith.

Overrides:

setWith in class AbstractOpticalElement

Parameters:

par - an array of Object objects

Throws:

IllegalStateException - if element is initialized and inside DataBush.

See Also:

• AbstractDataBushElement.setWith(Object[])

toString

public String toString()

Returns the string representation of this element. Returns string describing this element. String is formated in input-file code. Returns a String that represents the value of this object. Returns a String that represents the value of this object.

Specified by:

toString in interface ISimpleElement

Overrides:

toString in class AbstractOpticalElement