org.eclipse.dawnsci.nexus.NXflipper Maven / Gradle / Ivy
/*-
*******************************************************************************
* Copyright (c) 2015 Diamond Light Source Ltd.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* This file was auto-generated from the NXDL XML definition.
*******************************************************************************/
package org.eclipse.dawnsci.nexus;
import org.eclipse.dawnsci.analysis.api.tree.DataNode;
import org.eclipse.january.dataset.IDataset;
/**
* A spin flipper.
*
*/
public interface NXflipper extends NXobject {
public static final String NX_TYPE = "type";
public static final String NX_FLIP_TURNS = "flip_turns";
public static final String NX_COMP_TURNS = "comp_turns";
public static final String NX_GUIDE_TURNS = "guide_turns";
public static final String NX_FLIP_CURRENT = "flip_current";
public static final String NX_COMP_CURRENT = "comp_current";
public static final String NX_GUIDE_CURRENT = "guide_current";
public static final String NX_THICKNESS = "thickness";
/**
*
*
Enumeration:
* - coil
* - current-sheet
*
*
* @return the value.
*/
public IDataset getType();
/**
*
*
Enumeration:
* - coil
* - current-sheet
*
*
* @param type the type
*/
public DataNode setType(IDataset type);
/**
*
*
Enumeration:
* - coil
* - current-sheet
*
*
* @return the value.
*/
public String getTypeScalar();
/**
*
*
Enumeration:
* - coil
* - current-sheet
*
*
* @param type the type
*/
public DataNode setTypeScalar(String type);
/**
* Linear density of turns (such as number of turns/cm) in flipping field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @return the value.
*/
public IDataset getFlip_turns();
/**
* Linear density of turns (such as number of turns/cm) in flipping field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @param flip_turns the flip_turns
*/
public DataNode setFlip_turns(IDataset flip_turns);
/**
* Linear density of turns (such as number of turns/cm) in flipping field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @return the value.
*/
public Double getFlip_turnsScalar();
/**
* Linear density of turns (such as number of turns/cm) in flipping field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @param flip_turns the flip_turns
*/
public DataNode setFlip_turnsScalar(Double flip_turns);
/**
* Linear density of turns (such as number of turns/cm) in compensating field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @return the value.
*/
public IDataset getComp_turns();
/**
* Linear density of turns (such as number of turns/cm) in compensating field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @param comp_turns the comp_turns
*/
public DataNode setComp_turns(IDataset comp_turns);
/**
* Linear density of turns (such as number of turns/cm) in compensating field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @return the value.
*/
public Double getComp_turnsScalar();
/**
* Linear density of turns (such as number of turns/cm) in compensating field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @param comp_turns the comp_turns
*/
public DataNode setComp_turnsScalar(Double comp_turns);
/**
* Linear density of turns (such as number of turns/cm) in guide field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @return the value.
*/
public IDataset getGuide_turns();
/**
* Linear density of turns (such as number of turns/cm) in guide field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @param guide_turns the guide_turns
*/
public DataNode setGuide_turns(IDataset guide_turns);
/**
* Linear density of turns (such as number of turns/cm) in guide field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @return the value.
*/
public Double getGuide_turnsScalar();
/**
* Linear density of turns (such as number of turns/cm) in guide field coils
*
* Type: NX_FLOAT
* Units: NX_PER_LENGTH
*
*
* @param guide_turns the guide_turns
*/
public DataNode setGuide_turnsScalar(Double guide_turns);
/**
* Flipping field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @return the value.
*/
public IDataset getFlip_current();
/**
* Flipping field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @param flip_current the flip_current
*/
public DataNode setFlip_current(IDataset flip_current);
/**
* Flipping field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @return the value.
*/
public Double getFlip_currentScalar();
/**
* Flipping field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @param flip_current the flip_current
*/
public DataNode setFlip_currentScalar(Double flip_current);
/**
* Compensating field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @return the value.
*/
public IDataset getComp_current();
/**
* Compensating field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @param comp_current the comp_current
*/
public DataNode setComp_current(IDataset comp_current);
/**
* Compensating field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @return the value.
*/
public Double getComp_currentScalar();
/**
* Compensating field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @param comp_current the comp_current
*/
public DataNode setComp_currentScalar(Double comp_current);
/**
* Guide field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @return the value.
*/
public IDataset getGuide_current();
/**
* Guide field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @param guide_current the guide_current
*/
public DataNode setGuide_current(IDataset guide_current);
/**
* Guide field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @return the value.
*/
public Double getGuide_currentScalar();
/**
* Guide field coil current in "on" state"
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @param guide_current the guide_current
*/
public DataNode setGuide_currentScalar(Double guide_current);
/**
* thickness along path of neutron travel
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getThickness();
/**
* thickness along path of neutron travel
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param thickness the thickness
*/
public DataNode setThickness(IDataset thickness);
/**
* thickness along path of neutron travel
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getThicknessScalar();
/**
* thickness along path of neutron travel
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param thickness the thickness
*/
public DataNode setThicknessScalar(Double thickness);
}