Package cern.accsoft.steering.jmad.domain.beam

Enum Beam.Direction

  • All Implemented Interfaces:
    MadxValue, java.io.Serializable, java.lang.Comparable<Beam.Direction>
    Enclosing class:
    Beam
    public static enum Beam.Direction
extends java.lang.Enum<Beam.Direction>
implements MadxValue
    Represents the direction of the beam in MadX. This is the java equivalent to the bv flag in MadX. It was introduced in MadX especially for the needs of LHC design in order to cope with two beams circulating in opposite directions.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      MINUS
      Represents a beam going in the opposite direction as the sequence is defined.
      PLUS
      Represents a beam going in the direction of as the sequence is defined.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getMadxString()  
      static Beam.Direction valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Beam.Direction[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • PLUS

        public static final Beam.Direction PLUS
        Represents a beam going in the direction of as the sequence is defined. (e.g. LHC beam 1)

      • MINUS

        public static final Beam.Direction MINUS
        Represents a beam going in the opposite direction as the sequence is defined. (e.g.LHC beam 2)

    • Method Detail

      • values

        public static Beam.Direction[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Beam.Direction c : Beam.Direction.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Beam.Direction valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getMadxString

        public java.lang.String getMadxString()
        Specified by:
        getMadxString in interface MadxValue