org.eclipse.dawnsci.nexus.NXmirror 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 beamline mirror or supermirror.
*
*/
public interface NXmirror extends NXobject {
public static final String NX_TYPE = "type";
public static final String NX_DESCRIPTION = "description";
public static final String NX_INCIDENT_ANGLE = "incident_angle";
public static final String NX_BEND_ANGLE_X = "bend_angle_x";
public static final String NX_BEND_ANGLE_Y = "bend_angle_y";
public static final String NX_INTERIOR_ATMOSPHERE = "interior_atmosphere";
public static final String NX_EXTERNAL_MATERIAL = "external_material";
public static final String NX_M_VALUE = "m_value";
public static final String NX_SUBSTRATE_MATERIAL = "substrate_material";
public static final String NX_SUBSTRATE_DENSITY = "substrate_density";
public static final String NX_SUBSTRATE_THICKNESS = "substrate_thickness";
public static final String NX_COATING_MATERIAL = "coating_material";
public static final String NX_SUBSTRATE_ROUGHNESS = "substrate_roughness";
public static final String NX_COATING_ROUGHNESS = "coating_roughness";
public static final String NX_EVEN_LAYER_MATERIAL = "even_layer_material";
public static final String NX_EVEN_LAYER_DENSITY = "even_layer_density";
public static final String NX_ODD_LAYER_MATERIAL = "odd_layer_material";
public static final String NX_ODD_LAYER_DENSITY = "odd_layer_density";
public static final String NX_LAYER_THICKNESS = "layer_thickness";
/**
*
* @return the value.
*/
public NXgeometry getGeometry();
/**
*
* @param geometry the geometry
*/
public void setGeometry(NXgeometry geometry);
/**
* Get a NXgeometry node by name:
*
*
*
*
* @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:
*
*
*
*
* @param name the name of the node
* @param geometry the value to set
*/
public void setGeometry(String name, NXgeometry geometry);
/**
* Get all NXgeometry nodes:
*
*
*
*
* @return a map from node names to the NXgeometry for that node.
*/
public Map getAllGeometry();
/**
* Set multiple child nodes of a particular type.
*
*
*
*
* @param geometry the child nodes to add
*/
public void setAllGeometry(Map geometry);
/**
*
*
Enumeration:
* - single
* mirror with a single material as a reflecting surface
* - multi
* mirror with stacked, multiple layers as a reflecting surface
*
*
* @return the value.
*/
public IDataset getType();
/**
*
*
Enumeration:
* - single
* mirror with a single material as a reflecting surface
* - multi
* mirror with stacked, multiple layers as a reflecting surface
*
*
* @param type the type
*/
public DataNode setType(IDataset type);
/**
*
*
Enumeration:
* - single
* mirror with a single material as a reflecting surface
* - multi
* mirror with stacked, multiple layers as a reflecting surface
*
*
* @return the value.
*/
public String getTypeScalar();
/**
*
*
Enumeration:
* - single
* mirror with a single material as a reflecting surface
* - multi
* mirror with stacked, multiple layers as a reflecting surface
*
*
* @param type the type
*/
public DataNode setTypeScalar(String type);
/**
* description of this mirror
*
* @return the value.
*/
public IDataset getDescription();
/**
* description of this mirror
*
* @param description the description
*/
public DataNode setDescription(IDataset description);
/**
* description of this mirror
*
* @return the value.
*/
public String getDescriptionScalar();
/**
* description of this mirror
*
* @param description the description
*/
public DataNode setDescriptionScalar(String description);
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @return the value.
*/
public IDataset getIncident_angle();
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @param incident_angle the incident_angle
*/
public DataNode setIncident_angle(IDataset incident_angle);
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @return the value.
*/
public Double getIncident_angleScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @param incident_angle the incident_angle
*/
public DataNode setIncident_angleScalar(Double incident_angle);
/**
* Reflectivity as function of wavelength
*
* @return the value.
*/
public NXdata getReflectivity();
/**
* Reflectivity as function of wavelength
*
* @param reflectivity the reflectivity
*/
public void setReflectivity(NXdata reflectivity);
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @return the value.
*/
public IDataset getBend_angle_x();
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @param bend_angle_x the bend_angle_x
*/
public DataNode setBend_angle_x(IDataset bend_angle_x);
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @return the value.
*/
public Double getBend_angle_xScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @param bend_angle_x the bend_angle_x
*/
public DataNode setBend_angle_xScalar(Double bend_angle_x);
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @return the value.
*/
public IDataset getBend_angle_y();
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @param bend_angle_y the bend_angle_y
*/
public DataNode setBend_angle_y(IDataset bend_angle_y);
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @return the value.
*/
public Double getBend_angle_yScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_ANGLE
*
*
* @param bend_angle_y the bend_angle_y
*/
public DataNode setBend_angle_yScalar(Double bend_angle_y);
/**
*
*
Enumeration:
* - vacuum
* - helium
* - argon
*
*
* @return the value.
*/
public IDataset getInterior_atmosphere();
/**
*
*
Enumeration:
* - vacuum
* - helium
* - argon
*
*
* @param interior_atmosphere the interior_atmosphere
*/
public DataNode setInterior_atmosphere(IDataset interior_atmosphere);
/**
*
*
Enumeration:
* - vacuum
* - helium
* - argon
*
*
* @return the value.
*/
public String getInterior_atmosphereScalar();
/**
*
*
Enumeration:
* - vacuum
* - helium
* - argon
*
*
* @param interior_atmosphere the interior_atmosphere
*/
public DataNode setInterior_atmosphereScalar(String interior_atmosphere);
/**
* external material outside substrate
*
* @return the value.
*/
public IDataset getExternal_material();
/**
* external material outside substrate
*
* @param external_material the external_material
*/
public DataNode setExternal_material(IDataset external_material);
/**
* external material outside substrate
*
* @return the value.
*/
public String getExternal_materialScalar();
/**
* external material outside substrate
*
* @param external_material the external_material
*/
public DataNode setExternal_materialScalar(String external_material);
/**
* The m value for a supermirror, which defines the supermirror
* regime in multiples of the critical angle of Nickel.
*
* Type: NX_FLOAT
* Units: NX_UNITLESS
*
*
* @return the value.
*/
public IDataset getM_value();
/**
* The m value for a supermirror, which defines the supermirror
* regime in multiples of the critical angle of Nickel.
*
* Type: NX_FLOAT
* Units: NX_UNITLESS
*
*
* @param m_value the m_value
*/
public DataNode setM_value(IDataset m_value);
/**
* The m value for a supermirror, which defines the supermirror
* regime in multiples of the critical angle of Nickel.
*
* Type: NX_FLOAT
* Units: NX_UNITLESS
*
*
* @return the value.
*/
public Double getM_valueScalar();
/**
* The m value for a supermirror, which defines the supermirror
* regime in multiples of the critical angle of Nickel.
*
* Type: NX_FLOAT
* Units: NX_UNITLESS
*
*
* @param m_value the m_value
*/
public DataNode setM_valueScalar(Double m_value);
/**
*
* @return the value.
*/
public IDataset getSubstrate_material();
/**
*
* @param substrate_material the substrate_material
*/
public DataNode setSubstrate_material(IDataset substrate_material);
/**
*
* @return the value.
*/
public String getSubstrate_materialScalar();
/**
*
* @param substrate_material the substrate_material
*/
public DataNode setSubstrate_materialScalar(String substrate_material);
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @return the value.
*/
public IDataset getSubstrate_density();
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @param substrate_density the substrate_density
*/
public DataNode setSubstrate_density(IDataset substrate_density);
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @return the value.
*/
public Double getSubstrate_densityScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @param substrate_density the substrate_density
*/
public DataNode setSubstrate_densityScalar(Double substrate_density);
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getSubstrate_thickness();
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param substrate_thickness the substrate_thickness
*/
public DataNode setSubstrate_thickness(IDataset substrate_thickness);
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getSubstrate_thicknessScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param substrate_thickness the substrate_thickness
*/
public DataNode setSubstrate_thicknessScalar(Double substrate_thickness);
/**
*
* @return the value.
*/
public IDataset getCoating_material();
/**
*
* @param coating_material the coating_material
*/
public DataNode setCoating_material(IDataset coating_material);
/**
*
* @return the value.
*/
public String getCoating_materialScalar();
/**
*
* @param coating_material the coating_material
*/
public DataNode setCoating_materialScalar(String coating_material);
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getSubstrate_roughness();
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param substrate_roughness the substrate_roughness
*/
public DataNode setSubstrate_roughness(IDataset substrate_roughness);
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getSubstrate_roughnessScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param substrate_roughness the substrate_roughness
*/
public DataNode setSubstrate_roughnessScalar(Double substrate_roughness);
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getCoating_roughness();
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param coating_roughness the coating_roughness
*/
public DataNode setCoating_roughness(IDataset coating_roughness);
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getCoating_roughnessScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param coating_roughness the coating_roughness
*/
public DataNode setCoating_roughnessScalar(Double coating_roughness);
/**
*
* @return the value.
*/
public IDataset getEven_layer_material();
/**
*
* @param even_layer_material the even_layer_material
*/
public DataNode setEven_layer_material(IDataset even_layer_material);
/**
*
* @return the value.
*/
public String getEven_layer_materialScalar();
/**
*
* @param even_layer_material the even_layer_material
*/
public DataNode setEven_layer_materialScalar(String even_layer_material);
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @return the value.
*/
public IDataset getEven_layer_density();
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @param even_layer_density the even_layer_density
*/
public DataNode setEven_layer_density(IDataset even_layer_density);
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @return the value.
*/
public Double getEven_layer_densityScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @param even_layer_density the even_layer_density
*/
public DataNode setEven_layer_densityScalar(Double even_layer_density);
/**
*
* @return the value.
*/
public IDataset getOdd_layer_material();
/**
*
* @param odd_layer_material the odd_layer_material
*/
public DataNode setOdd_layer_material(IDataset odd_layer_material);
/**
*
* @return the value.
*/
public String getOdd_layer_materialScalar();
/**
*
* @param odd_layer_material the odd_layer_material
*/
public DataNode setOdd_layer_materialScalar(String odd_layer_material);
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @return the value.
*/
public IDataset getOdd_layer_density();
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @param odd_layer_density the odd_layer_density
*/
public DataNode setOdd_layer_density(IDataset odd_layer_density);
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @return the value.
*/
public Double getOdd_layer_densityScalar();
/**
*
* Type: NX_FLOAT
* Units: NX_MASS_DENSITY
*
*
* @param odd_layer_density the odd_layer_density
*/
public DataNode setOdd_layer_densityScalar(Double odd_layer_density);
/**
* An array describing the thickness of each layer
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public IDataset getLayer_thickness();
/**
* An array describing the thickness of each layer
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param layer_thickness the layer_thickness
*/
public DataNode setLayer_thickness(IDataset layer_thickness);
/**
* An array describing the thickness of each layer
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @return the value.
*/
public Double getLayer_thicknessScalar();
/**
* An array describing the thickness of each layer
*
* Type: NX_FLOAT
* Units: NX_LENGTH
*
*
* @param layer_thickness the layer_thickness
*/
public DataNode setLayer_thicknessScalar(Double layer_thickness);
/**
* A NXshape group describing the shape of the mirror
*
* @return the value.
*/
public NXshape getShape();
/**
* A NXshape group describing the shape of the mirror
*
* @param shape the shape
*/
public void setShape(NXshape shape);
/**
* Numerical description of the surface figure of the mirror.
*
* @return the value.
*/
public NXdata getFigure_data();
/**
* Numerical description of the surface figure of the mirror.
*
* @param figure_data the figure_data
*/
public void setFigure_data(NXdata figure_data);
}