SequenceImpl.java

// @formatter:off
 /*******************************************************************************
 *
 * This file is part of JMad.
 * 
 * Copyright (c) 2008-2011, CERN. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 ******************************************************************************/
// @formatter:on

package cern.accsoft.steering.jmad.domain.machine;

import java.util.ArrayList;
import java.util.List;

import cern.accsoft.steering.jmad.domain.beam.Beam;

/**
 * Represents a <a href="http://mad.web.cern.ch/mad/Introduction/sequence.html">SEQUENCE</a> in the MadX-model. This
 * class also manages the its ranges and knows about its own {@link SequenceDefinition}.
 * 
 * @author Kajetan Fuchsberger (kajetan.fuchsberger at cern.ch)
 */
public class SequenceImpl implements Sequence {

    /** The definition from which this sequence is derived */
    private final SequenceDefinition sequenceDefinition;

    /** the available ranges of the sequence */
    private final List<Range> ranges = new ArrayList<Range>();

    /**
     * simple constructor, just give the sequenceDefinition.
     * 
     * @param sequenceDefinition the {@link SequenceDefinition} to use to create this sequence
     */
    public SequenceImpl(SequenceDefinition sequenceDefinition) {
        this.sequenceDefinition = sequenceDefinition;
        for (RangeDefinition rangeDefinition : this.sequenceDefinition.getRangeDefinitions()) {
            this.ranges.add(new Range(rangeDefinition));
        }
    }

    @Override
    public String getName() {
        return getSequenceDefinition().getName();
    }

    @Override
    public List<Range> getRanges() {
        return ranges;
    }

    @Override
    public Range getDefaultRange() {
        /*
         * we just return the first entry, if available.
         */
        if (ranges.isEmpty()) {
            return null;
        } else {
            return ranges.get(0);
        }
    }

    @Override
    public String toString() {
        return getName();
    }

    @Override
    public final Beam getBeam() {
        return getSequenceDefinition().getBeam();
    }

    public SequenceDefinition getSequenceDefinition() {
        return sequenceDefinition;
    }
}