org.eclipse.dawnsci.nexus.NXattenuator 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 java.util.Date;

import org.eclipse.dawnsci.analysis.api.tree.DataNode;
import org.eclipse.january.dataset.IDataset;

/**
 * A device that reduces the intensity of a beam by attenuation.
 * If uncertain whether to use :ref:`NXfilter` (band-pass filter)
 * or :ref:`NXattenuator` (reduces beam intensity), then choose
 * :ref:`NXattenuator`.
 * 
 */
public interface NXattenuator extends NXobject {

	public static final String NX_DISTANCE = "distance";
	public static final String NX_TYPE = "type";
	public static final String NX_THICKNESS = "thickness";
	public static final String NX_SCATTERING_CROSS_SECTION = "scattering_cross_section";
	public static final String NX_ABSORPTION_CROSS_SECTION = "absorption_cross_section";
	public static final String NX_ATTENUATOR_TRANSMISSION = "attenuator_transmission";
	public static final String NX_STATUS = "status";
	public static final String NX_STATUS_ATTRIBUTE_TIME = "time";
	/**
	 * Distance from sample
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_LENGTH
	 * 
	 * 
	 * @return  the value.
	 */
	public IDataset getDistance();
	
	/**
	 * Distance from sample
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_LENGTH
	 * 
	 * 
	 * @param distance the distance
	 */
	public DataNode setDistance(IDataset distance);

	/**
	 * Distance from sample
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_LENGTH
	 * 
	 * 
	 * @return  the value.
	 */
	public Double getDistanceScalar();

	/**
	 * Distance from sample
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_LENGTH
	 * 
	 * 
	 * @param distance the distance
	 */
	public DataNode setDistanceScalar(Double distance);

	/**
	 * Type or composition of attenuator, e.g. polythene
	 * 
	 * @return  the value.
	 */
	public IDataset getType();
	
	/**
	 * Type or composition of attenuator, e.g. polythene
	 * 
	 * @param type the type
	 */
	public DataNode setType(IDataset type);

	/**
	 * Type or composition of attenuator, e.g. polythene
	 * 
	 * @return  the value.
	 */
	public String getTypeScalar();

	/**
	 * Type or composition of attenuator, e.g. polythene
	 * 
	 * @param type the type
	 */
	public DataNode setTypeScalar(String type);

	/**
	 * Thickness of attenuator along beam direction
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_LENGTH
	 * 
	 * 
	 * @return  the value.
	 */
	public IDataset getThickness();
	
	/**
	 * Thickness of attenuator along beam direction
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_LENGTH
	 * 
	 * 
	 * @param thickness the thickness
	 */
	public DataNode setThickness(IDataset thickness);

	/**
	 * Thickness of attenuator along beam direction
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_LENGTH
	 * 
	 * 
	 * @return  the value.
	 */
	public Double getThicknessScalar();

	/**
	 * Thickness of attenuator along beam direction
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_LENGTH
	 * 
	 * 
	 * @param thickness the thickness
	 */
	public DataNode setThicknessScalar(Double thickness);

	/**
	 * Scattering cross section (coherent+incoherent)
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_CROSS_SECTION
	 * 
	 * 
	 * @return  the value.
	 */
	public IDataset getScattering_cross_section();
	
	/**
	 * Scattering cross section (coherent+incoherent)
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_CROSS_SECTION
	 * 
	 * 
	 * @param scattering_cross_section the scattering_cross_section
	 */
	public DataNode setScattering_cross_section(IDataset scattering_cross_section);

	/**
	 * Scattering cross section (coherent+incoherent)
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_CROSS_SECTION
	 * 
	 * 
	 * @return  the value.
	 */
	public Double getScattering_cross_sectionScalar();

	/**
	 * Scattering cross section (coherent+incoherent)
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_CROSS_SECTION
	 * 
	 * 
	 * @param scattering_cross_section the scattering_cross_section
	 */
	public DataNode setScattering_cross_sectionScalar(Double scattering_cross_section);

	/**
	 * Absorption cross section
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_CROSS_SECTION
	 * 
	 * 
	 * @return  the value.
	 */
	public IDataset getAbsorption_cross_section();
	
	/**
	 * Absorption cross section
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_CROSS_SECTION
	 * 
	 * 
	 * @param absorption_cross_section the absorption_cross_section
	 */
	public DataNode setAbsorption_cross_section(IDataset absorption_cross_section);

	/**
	 * Absorption cross section
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_CROSS_SECTION
	 * 
	 * 
	 * @return  the value.
	 */
	public Double getAbsorption_cross_sectionScalar();

	/**
	 * Absorption cross section
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_CROSS_SECTION
	 * 
	 * 
	 * @param absorption_cross_section the absorption_cross_section
	 */
	public DataNode setAbsorption_cross_sectionScalar(Double absorption_cross_section);

	/**
	 * The nominal amount of the beam that gets through
	 * (transmitted intensity)/(incident intensity)
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_DIMENSIONLESS
	 * 
	 * 
	 * @return  the value.
	 */
	public IDataset getAttenuator_transmission();
	
	/**
	 * The nominal amount of the beam that gets through
	 * (transmitted intensity)/(incident intensity)
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_DIMENSIONLESS
	 * 
	 * 
	 * @param attenuator_transmission the attenuator_transmission
	 */
	public DataNode setAttenuator_transmission(IDataset attenuator_transmission);

	/**
	 * The nominal amount of the beam that gets through
	 * (transmitted intensity)/(incident intensity)
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_DIMENSIONLESS
	 * 
	 * 
	 * @return  the value.
	 */
	public Double getAttenuator_transmissionScalar();

	/**
	 * The nominal amount of the beam that gets through
	 * (transmitted intensity)/(incident intensity)
	 * 
	 * Type: NX_FLOAT
	 * Units: NX_DIMENSIONLESS
	 * 
	 * 
	 * @param attenuator_transmission the attenuator_transmission
	 */
	public DataNode setAttenuator_transmissionScalar(Double attenuator_transmission);

	/**
	 * In or out or moving of the beam
	 * 
	 * 
Enumeration:

	 * in 
	 * out 
	 * moving 

	 * 
	 * 
	 * @return  the value.
	 */
	public IDataset getStatus();
	
	/**
	 * In or out or moving of the beam
	 * 
	 * 
Enumeration:

	 * in 
	 * out 
	 * moving 

	 * 
	 * 
	 * @param status the status
	 */
	public DataNode setStatus(IDataset status);

	/**
	 * In or out or moving of the beam
	 * 
	 * 
Enumeration:

	 * in 
	 * out 
	 * moving 

	 * 
	 * 
	 * @return  the value.
	 */
	public String getStatusScalar();

	/**
	 * In or out or moving of the beam
	 * 
	 * 
Enumeration:

	 * in 
	 * out 
	 * moving 

	 * 
	 * 
	 * @param status the status
	 */
	public DataNode setStatusScalar(String status);

	/**
	 * time stamp for this observation
	 * 
	 * @return  the value.
	 */
	public Date getStatusAttributeTime();
	
	/**
	 * time stamp for this observation
	 * 
	 * @param time the time
	 */
	public void setStatusAttributeTime(Date time);

}