org.eclipse.dawnsci.nexus.NXmoderator 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 neutron moderator
*
*/
public interface NXmoderator extends NXobject {
public static final String NX_DISTANCE = "distance";
public static final String NX_TYPE = "type";
public static final String NX_POISON_DEPTH = "poison_depth";
public static final String NX_COUPLED = "coupled";
public static final String NX_COUPLING_MATERIAL = "coupling_material";
public static final String NX_POISON_MATERIAL = "poison_material";
public static final String NX_TEMPERATURE = "temperature";
/**
* "Engineering" position of moderator
*
* @return the value.
*/
public NXgeometry getGeometry();
/**
* "Engineering" position of moderator
*
* @param geometry the geometry
*/
public void setGeometry(NXgeometry geometry);
/**
* Get a NXgeometry node by name:
*
* -
* "Engineering" position of moderator
*
*
* @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" position of moderator
*
*
* @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" position of moderator
*
*
* @return a map from node names to the NXgeometry for that node.
*/
public Map getAllGeometry();
/**
* Set multiple child nodes of a particular type.
*
* -
* "Engineering" position of moderator
*
*
* @param geometry the child nodes to add
*/
public void setAllGeometry(Map geometry);
/**
* Effective distance as seen by measuring radiation
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getDistance();
/**
* Effective distance as seen by measuring radiation
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param distance the distance
*/
public DataNode setDistance(IDataset distance);
/**
* Effective distance as seen by measuring radiation
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getDistanceScalar();
/**
* Effective distance as seen by measuring radiation
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param distance the distance
*/
public DataNode setDistanceScalar(Double distance);
/**
*
*
Enumeration:
* - H20
* - D20
* - Liquid H2
* - Liquid CH4
* - Liquid D2
* - Solid D2
* - C
* - Solid CH4
* - Solid H2
*
*
* @return the value.
*/
public IDataset getType();
/**
*
*
Enumeration:
* - H20
* - D20
* - Liquid H2
* - Liquid CH4
* - Liquid D2
* - Solid D2
* - C
* - Solid CH4
* - Solid H2
*
*
* @param type the type
*/
public DataNode setType(IDataset type);
/**
*
*
Enumeration:
* - H20
* - D20
* - Liquid H2
* - Liquid CH4
* - Liquid D2
* - Solid D2
* - C
* - Solid CH4
* - Solid H2
*
*
* @return the value.
*/
public String getTypeScalar();
/**
*
*
Enumeration:
* - H20
* - D20
* - Liquid H2
* - Liquid CH4
* - Liquid D2
* - Solid D2
* - C
* - Solid CH4
* - Solid H2
*
*
* @param type the type
*/
public DataNode setTypeScalar(String type);
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getPoison_depth();
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param poison_depth the poison_depth
*/
public DataNode setPoison_depth(IDataset poison_depth);
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getPoison_depthScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param poison_depth the poison_depth
*/
public DataNode setPoison_depthScalar(Double poison_depth);
/**
* whether the moderator is coupled
*
* Type: NX_BOOLEAN
*
*
* @return the value.
*/
public IDataset getCoupled();
/**
* whether the moderator is coupled
*
* Type: NX_BOOLEAN
*
*
* @param coupled the coupled
*/
public DataNode setCoupled(IDataset coupled);
/**
* whether the moderator is coupled
*
* Type: NX_BOOLEAN
*
*
* @return the value.
*/
public Boolean getCoupledScalar();
/**
* whether the moderator is coupled
*
* Type: NX_BOOLEAN
*
*
* @param coupled the coupled
*/
public DataNode setCoupledScalar(Boolean coupled);
/**
* The material used for coupling. Usually Cd.
*
* @return the value.
*/
public IDataset getCoupling_material();
/**
* The material used for coupling. Usually Cd.
*
* @param coupling_material the coupling_material
*/
public DataNode setCoupling_material(IDataset coupling_material);
/**
* The material used for coupling. Usually Cd.
*
* @return the value.
*/
public String getCoupling_materialScalar();
/**
* The material used for coupling. Usually Cd.
*
* @param coupling_material the coupling_material
*/
public DataNode setCoupling_materialScalar(String coupling_material);
/**
*
*
Enumeration:
* - Gd
* - Cd
*
*
* @return the value.
*/
public IDataset getPoison_material();
/**
*
*
Enumeration:
* - Gd
* - Cd
*
*
* @param poison_material the poison_material
*/
public DataNode setPoison_material(IDataset poison_material);
/**
*
*
Enumeration:
* - Gd
* - Cd
*
*
* @return the value.
*/
public String getPoison_materialScalar();
/**
*
*
Enumeration:
* - Gd
* - Cd
*
*
* @param poison_material the poison_material
*/
public DataNode setPoison_materialScalar(String poison_material);
/**
* average/nominal moderator temperature
*
* Type: NX_FLOAT
* Units: NX_TEMPERATURE
*
*
* @return the value.
*/
public IDataset getTemperature();
/**
* average/nominal moderator temperature
*
* Type: NX_FLOAT
* Units: NX_TEMPERATURE
*
*
* @param temperature the temperature
*/
public DataNode setTemperature(IDataset temperature);
/**
* average/nominal moderator temperature
*
* Type: NX_FLOAT
* Units: NX_TEMPERATURE
*
*
* @return the value.
*/
public Double getTemperatureScalar();
/**
* average/nominal moderator temperature
*
* Type: NX_FLOAT
* Units: NX_TEMPERATURE
*
*
* @param temperature the temperature
*/
public DataNode setTemperatureScalar(Double temperature);
/**
* log file of moderator temperature
*
* @return the value.
*/
public NXlog getTemperature_log();
/**
* log file of moderator temperature
*
* @param temperature_log the temperature_log
*/
public void setTemperature_log(NXlog temperature_log);
/**
* moderator pulse shape
*
* @return the value.
*/
public NXdata getPulse_shape();
/**
* moderator pulse shape
*
* @param pulse_shape the pulse_shape
*/
public void setPulse_shape(NXdata pulse_shape);
}