OpticUtil.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.model;

import java.util.List;

import cern.accsoft.steering.jmad.domain.ex.JMadModelException;
import cern.accsoft.steering.jmad.domain.optics.Optic;
import cern.accsoft.steering.jmad.domain.optics.OpticImpl;
import cern.accsoft.steering.jmad.domain.optics.OpticPoint;
import cern.accsoft.steering.jmad.domain.optics.OpticPointImpl;
import cern.accsoft.steering.jmad.domain.result.tfs.TfsResult;
import cern.accsoft.steering.jmad.domain.result.tfs.TfsResultRequest;
import cern.accsoft.steering.jmad.domain.result.tfs.TfsResultRequestImpl;
import cern.accsoft.steering.jmad.domain.var.enums.MadxTwissVariable;

/**
 * collectiion of utility methods for the Model
 * 
 * @author Kajetan Fuchsberger (kajetan.fuchsberger at cern.ch)
 */
public final class OpticUtil {

    private OpticUtil() {
        /* only static methods */
    }

    public static Optic calcOptic(JMadModel model) throws JMadModelException {
        TfsResultRequest resultRequest = fullOpticsRequest();
        TfsResult tfsResult = model.twiss(resultRequest);
        List<MadxTwissVariable> variables = allOpticsVariables();
        return createOptic(tfsResult, variables.toArray(new MadxTwissVariable[variables.size()]));
    }

    /**
     * Creates a Tfs request which will contain all elements and all Madx twiss variables which are required for the
     * optics.
     * 
     * @return the result request which can be used for a twiss.
     */
    public static final TfsResultRequest fullOpticsRequest() {
        TfsResultRequestImpl resultRequest = new TfsResultRequestImpl();
        resultRequest.addElementFilter(".*");

        resultRequest.addVariable(MadxTwissVariable.NAME);
        List<MadxTwissVariable> variables = allOpticsVariables();
        for (MadxTwissVariable var : variables) {
            resultRequest.addVariable(var);
        }
        return resultRequest;
    }

    private static List<MadxTwissVariable> allOpticsVariables() {
        return OpticPointImpl.MADX_VARIABLES;
    }

    public static Optic createOptic(TfsResult tfsResult, MadxTwissVariable... variables) {
        OpticImpl optic = new OpticImpl();

        /*
         * store the values from the twiss result
         */
        for (MadxTwissVariable var : variables) {
            optic.add(var, tfsResult.getDoubleData(var));
        }

        /*
         * get the names and check, if the size is still the same.
         */
        List<String> names = tfsResult.getStringData(MadxTwissVariable.NAME);
        optic.setNames(names);

        for (int i = 0; i < names.size(); i++) {
            String name = names.get(i);
            OpticPoint point = new OpticPointImpl(name);
            for (MadxTwissVariable var : variables) {
                ((OpticPointImpl) point).setValue(var, optic.getAllValues(var)
                        .get(i));
            }
            optic.add(point);
        }

        return optic;
    }
}