org.eclipse.dawnsci.nexus.NXbeam_stop 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.Map;
import org.eclipse.dawnsci.analysis.api.tree.DataNode;
import org.eclipse.january.dataset.IDataset;
/**
* A device that blocks the beam completely, usually to protect a detector.
* Beamstops and their positions are important for SANS
* and SAXS experiments.
*
*/
public interface NXbeam_stop extends NXobject {
public static final String NX_DESCRIPTION = "description";
public static final String NX_SIZE = "size";
public static final String NX_X = "x";
public static final String NX_Y = "y";
public static final String NX_DISTANCE_TO_DETECTOR = "distance_to_detector";
public static final String NX_STATUS = "status";
/**
* engineering shape, orientation and position of the beam stop.
*
* @return the value.
*/
public NXgeometry getGeometry();
/**
* engineering shape, orientation and position of the beam stop.
*
* @param geometry the geometry
*/
public void setGeometry(NXgeometry geometry);
/**
* Get a NXgeometry node by name:
*
* -
* engineering shape, orientation and position of the beam stop.
*
*
* @param name the name of the node.
* @return a map from node names to the NXgeometry for that node.
*/
public NXgeometry getGeometry(String name);
/**
* Set a NXgeometry node by name:
*
* -
* engineering shape, orientation and position of the beam stop.
*
*
* @param name the name of the node
* @param geometry the value to set
*/
public void setGeometry(String name, NXgeometry geometry);
/**
* Get all NXgeometry nodes:
*
* -
* engineering shape, orientation and position of the beam stop.
*
*
* @return a map from node names to the NXgeometry for that node.
*/
public Map getAllGeometry();
/**
* Set multiple child nodes of a particular type.
*
* -
* engineering shape, orientation and position of the beam stop.
*
*
* @param geometry the child nodes to add
*/
public void setAllGeometry(Map geometry);
/**
* description of beamstop
*
*
Enumeration:
* - circular
* - rectangular
*
*
* @return the value.
*/
public IDataset getDescription();
/**
* description of beamstop
*
*
Enumeration:
* - circular
* - rectangular
*
*
* @param description the description
*/
public DataNode setDescription(IDataset description);
/**
* description of beamstop
*
*
Enumeration:
* - circular
* - rectangular
*
*
* @return the value.
*/
public String getDescriptionScalar();
/**
* description of beamstop
*
*
Enumeration:
* - circular
* - rectangular
*
*
* @param description the description
*/
public DataNode setDescriptionScalar(String description);
/**
* size of beamstop
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getSize();
/**
* size of beamstop
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param size the size
*/
public DataNode setSize(IDataset size);
/**
* size of beamstop
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getSizeScalar();
/**
* size of beamstop
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param size the size
*/
public DataNode setSizeScalar(Double size);
/**
* x position of the beamstop in relation to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getX();
/**
* x position of the beamstop in relation to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param x the x
*/
public DataNode setX(IDataset x);
/**
* x position of the beamstop in relation to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getXScalar();
/**
* x position of the beamstop in relation to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param x the x
*/
public DataNode setXScalar(Double x);
/**
* y position of the beamstop in relation to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getY();
/**
* y position of the beamstop in relation to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param y the y
*/
public DataNode setY(IDataset y);
/**
* y position of the beamstop in relation to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getYScalar();
/**
* y position of the beamstop in relation to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param y the y
*/
public DataNode setYScalar(Double y);
/**
* distance of the beamstop to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getDistance_to_detector();
/**
* distance of the beamstop to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param distance_to_detector the distance_to_detector
*/
public DataNode setDistance_to_detector(IDataset distance_to_detector);
/**
* distance of the beamstop to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getDistance_to_detectorScalar();
/**
* distance of the beamstop to the detector
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param distance_to_detector the distance_to_detector
*/
public DataNode setDistance_to_detectorScalar(Double distance_to_detector);
/**
*
*
Enumeration:
* - in
* - out
*
*
* @return the value.
*/
public IDataset getStatus();
/**
*
*
Enumeration:
* - in
* - out
*
*
* @param status the status
*/
public DataNode setStatus(IDataset status);
/**
*
*
Enumeration:
* - in
* - out
*
*
* @return the value.
*/
public String getStatusScalar();
/**
*
*
Enumeration:
* - in
* - out
*
*
* @param status the status
*/
public DataNode setStatusScalar(String status);
}