Package cern.accsoft.steering.jmad.domain.machine

Class SequenceDefinitionImpl

java.lang.Object

cern.accsoft.steering.jmad.domain.machine.SequenceDefinitionImpl

All Implemented Interfaces:

SequenceDefinition

public class SequenceDefinitionImpl
extends java.lang.Object
implements SequenceDefinition

The default implementation for a sequence-definition. A Sequence definition represents a set of files that define a SEQUENCE in MadX.

This sequence definition also contains several ranges and the beam command associated with the sequence.

Constructor Summary

Constructors

Constructor	Description
SequenceDefinitionImpl()	default constructor for xstream
SequenceDefinitionImpl(java.lang.String name)
SequenceDefinitionImpl(java.lang.String name, Beam beam)	the constructor, which enforces to set a name and a beam.

Method Summary

Modifier and Type	Method	Description
void	addRangeDefinition(RangeDefinition rangeDefinition)	adds a RangeDefinition to the sequence
boolean	equals(java.lang.Object obj)
Beam	getBeam()
RangeDefinition	getDefaultRangeDefinition()
java.lang.String	getName()
RangeDefinition	getRangeDefinition(java.lang.String rangeName)	returns the range definition of the given name or null
java.util.List<RangeDefinition>	getRangeDefinitions()
int	hashCode()
void	setBeam(Beam beam)
void	setDefaultRangeDefinition(RangeDefinition rangeDefinition)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceDefinitionImpl

public SequenceDefinitionImpl()

default constructor for xstream

SequenceDefinitionImpl

public SequenceDefinitionImpl(java.lang.String name,
                              Beam beam)

the constructor, which enforces to set a name and a beam.

Parameters:

name - the name of the Sequence

beam - the beam for this sequence. Occasionally this might be null.

SequenceDefinitionImpl

public SequenceDefinitionImpl(java.lang.String name)

Method Detail

setBeam

public void setBeam(Beam beam)

getBeam

public Beam getBeam()

Specified by:

getBeam in interface SequenceDefinition

Returns:

the beam to use for this sequence.

getName

public java.lang.String getName()

Specified by:

getName in interface SequenceDefinition

Returns:

the name of the sequence

getRangeDefinitions

public java.util.List<RangeDefinition> getRangeDefinitions()

Specified by:

getRangeDefinitions in interface SequenceDefinition

Returns:

the range-definitions for this sequence

getDefaultRangeDefinition

public RangeDefinition getDefaultRangeDefinition()

Specified by:

getDefaultRangeDefinition in interface SequenceDefinition

Returns:

the rangeDefinition, which shall be selected by default

setDefaultRangeDefinition

public void setDefaultRangeDefinition(RangeDefinition rangeDefinition)

addRangeDefinition

public void addRangeDefinition(RangeDefinition rangeDefinition)

adds a RangeDefinition to the sequence

Parameters:

rangeDefinition - the RangeDefinition to add

getRangeDefinition

public final RangeDefinition getRangeDefinition(java.lang.String rangeName)

Description copied from interface: SequenceDefinition

returns the range definition of the given name or null

Specified by:

getRangeDefinition in interface SequenceDefinition

Parameters:

rangeName - the name of the range definition to find

Returns:

the range definition of the given name if available

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object