org.eclipse.dawnsci.nexus.NXcapillary 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 capillary lens to focus the X-ray beam.
* Based on information provided by Gerd Wellenreuther (DESY).
*
*/
public interface NXcapillary extends NXobject {
public static final String NX_TYPE = "type";
public static final String NX_MANUFACTURER = "manufacturer";
public static final String NX_MAXIMUM_INCIDENT_ANGLE = "maximum_incident_angle";
public static final String NX_ACCEPTING_APERTURE = "accepting_aperture";
public static final String NX_WORKING_DISTANCE = "working_distance";
public static final String NX_FOCAL_SIZE = "focal_size";
/**
* Type of the capillary
*
* Type: NX_CHAR
*
Enumeration:
* - single_bounce
* - polycapillary
* - conical_capillary
*
*
* @return the value.
*/
public IDataset getType();
/**
* Type of the capillary
*
* Type: NX_CHAR
*
Enumeration:
* - single_bounce
* - polycapillary
* - conical_capillary
*
*
* @param type the type
*/
public DataNode setType(IDataset type);
/**
* Type of the capillary
*
* Type: NX_CHAR
*
Enumeration:
* - single_bounce
* - polycapillary
* - conical_capillary
*
*
* @return the value.
*/
public String getTypeScalar();
/**
* Type of the capillary
*
* Type: NX_CHAR
*
Enumeration:
* - single_bounce
* - polycapillary
* - conical_capillary
*
*
* @param type the type
*/
public DataNode setTypeScalar(String type);
/**
* The manufacturer of the capillary. This is actually important as
* it may have an impact on performance.
*
* Type: NX_CHAR
*
*
* @return the value.
*/
public IDataset getManufacturer();
/**
* The manufacturer of the capillary. This is actually important as
* it may have an impact on performance.
*
* Type: NX_CHAR
*
*
* @param manufacturer the manufacturer
*/
public DataNode setManufacturer(IDataset manufacturer);
/**
* The manufacturer of the capillary. This is actually important as
* it may have an impact on performance.
*
* Type: NX_CHAR
*
*
* @return the value.
*/
public String getManufacturerScalar();
/**
* The manufacturer of the capillary. This is actually important as
* it may have an impact on performance.
*
* Type: NX_CHAR
*
*
* @param manufacturer the manufacturer
*/
public DataNode setManufacturerScalar(String manufacturer);
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @return the value.
*/
public IDataset getMaximum_incident_angle();
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @param maximum_incident_angle the maximum_incident_angle
*/
public DataNode setMaximum_incident_angle(IDataset maximum_incident_angle);
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @return the value.
*/
public Double getMaximum_incident_angleScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @param maximum_incident_angle the maximum_incident_angle
*/
public DataNode setMaximum_incident_angleScalar(Double maximum_incident_angle);
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @return the value.
*/
public IDataset getAccepting_aperture();
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @param accepting_aperture the accepting_aperture
*/
public DataNode setAccepting_aperture(IDataset accepting_aperture);
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @return the value.
*/
public Double getAccepting_apertureScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @param accepting_aperture the accepting_aperture
*/
public DataNode setAccepting_apertureScalar(Double accepting_aperture);
/**
* The gain of the capillary as a function of energy
*
* @return the value.
*/
public NXdata getGain();
/**
* The gain of the capillary as a function of energy
*
* @param gain the gain
*/
public void setGain(NXdata gain);
/**
* The transmission of the capillary as a function of energy
*
* @return the value.
*/
public NXdata getTransmission();
/**
* The transmission of the capillary as a function of energy
*
* @param transmission the transmission
*/
public void setTransmission(NXdata transmission);
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getWorking_distance();
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param working_distance the working_distance
*/
public DataNode setWorking_distance(IDataset working_distance);
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getWorking_distanceScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param working_distance the working_distance
*/
public DataNode setWorking_distanceScalar(Double working_distance);
/**
* The focal size in FWHM
*
* Type: NX_FLOAT
*
*
* @return the value.
*/
public IDataset getFocal_size();
/**
* The focal size in FWHM
*
* Type: NX_FLOAT
*
*
* @param focal_size the focal_size
*/
public DataNode setFocal_size(IDataset focal_size);
/**
* The focal size in FWHM
*
* Type: NX_FLOAT
*
*
* @return the value.
*/
public Double getFocal_sizeScalar();
/**
* The focal size in FWHM
*
* Type: NX_FLOAT
*
*
* @param focal_size the focal_size
*/
public DataNode setFocal_sizeScalar(Double focal_size);
}