org.eclipse.dawnsci.nexus.NXsolenoid_magnet 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;
/**
* definition for a solenoid magnet.
*
*/
public interface NXsolenoid_magnet extends NXobject {
public static final String NX_DESCRIPTION = "description";
public static final String NX_BEAMLINE_DISTANCE = "beamline_distance";
public static final String NX_SET_CURRENT = "set_current";
/**
* extended description of the magnet.
*
* Type: NX_CHAR
*
*
* @return the value.
*/
public IDataset getDescription();
/**
* extended description of the magnet.
*
* Type: NX_CHAR
*
*
* @param description the description
*/
public DataNode setDescription(IDataset description);
/**
* extended description of the magnet.
*
* Type: NX_CHAR
*
*
* @return the value.
*/
public String getDescriptionScalar();
/**
* extended description of the magnet.
*
* Type: NX_CHAR
*
*
* @param description the description
*/
public DataNode setDescriptionScalar(String description);
/**
* define position of beamline element relative to production target
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getBeamline_distance();
/**
* define position of beamline element relative to production target
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param beamline_distance the beamline_distance
*/
public DataNode setBeamline_distance(IDataset beamline_distance);
/**
* define position of beamline element relative to production target
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getBeamline_distanceScalar();
/**
* define position of beamline element relative to production target
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param beamline_distance the beamline_distance
*/
public DataNode setBeamline_distanceScalar(Double beamline_distance);
/**
* current set on supply.
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @return the value.
*/
public IDataset getSet_current();
/**
* current set on supply.
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @param set_current the set_current
*/
public DataNode setSet_current(IDataset set_current);
/**
* current set on supply.
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @return the value.
*/
public Double getSet_currentScalar();
/**
* current set on supply.
*
* Type: NX_FLOAT
* Units: NX_CURRENT
*
*
* @param set_current the set_current
*/
public DataNode setSet_currentScalar(Double set_current);
/**
* current read from supply.
*
* @return the value.
*/
public NXlog getRead_current();
/**
* current read from supply.
*
* @param read_current the read_current
*/
public void setRead_current(NXlog read_current);
/**
* voltage read from supply.
*
* @return the value.
*/
public NXlog getRead_voltage();
/**
* voltage read from supply.
*
* @param read_voltage the read_voltage
*/
public void setRead_voltage(NXlog read_voltage);
}