All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.dawnsci.nexus.NXinstrument 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;

/**
 * Collection of the components of the instrument or beamline.
 * Template of instrument descriptions comprising various beamline components.
 * Each component will also be a NeXus group defined by its distance from the
 * sample. Negative distances represent beamline components that are before the
 * sample while positive distances represent components that are after the sample.
 * This device allows the unique identification of beamline components in a way
 * that is valid for both reactor and pulsed instrumentation.
 * 
 */
public interface NXinstrument extends NXobject {

	public static final String NX_NAME = "name";
	public static final String NX_NAME_ATTRIBUTE_SHORT_NAME = "short_name";
	/**
	 * Name of instrument
	 * 
	 * @return  the value.
	 */
	public IDataset getName();
	
	/**
	 * Name of instrument
	 * 
	 * @param name the name
	 */
	public DataNode setName(IDataset name);

	/**
	 * Name of instrument
	 * 
	 * @return  the value.
	 */
	public String getNameScalar();

	/**
	 * Name of instrument
	 * 
	 * @param name the name
	 */
	public DataNode setNameScalar(String name);

	/**
	 * short name for instrument, perhaps the acronym
	 * 
	 * @return  the value.
	 */
	public String getNameAttributeShort_name();
	
	/**
	 * short name for instrument, perhaps the acronym
	 * 
	 * @param short_name the short_name
	 */
	public void setNameAttributeShort_name(String short_name);

	/**
	 * 
	 * @return  the value.
	 */
	public NXaperture getAperture();
	
	/**
	 * 
	 * @param aperture the aperture
	 */
	public void setAperture(NXaperture aperture);
  
	/**
	 * Get a NXaperture node by name:
	 * 
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXaperture for that node. */ public NXaperture getAperture(String name); /** * Set a NXaperture node by name: *
    *
  • *
* * @param name the name of the node * @param aperture the value to set */ public void setAperture(String name, NXaperture aperture); /** * Get all NXaperture nodes: *
    *
  • *
* * @return a map from node names to the NXaperture for that node. */ public Map getAllAperture(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param aperture the child nodes to add */ public void setAllAperture(Map aperture); /** * * @return the value. */ public NXattenuator getAttenuator(); /** * * @param attenuator the attenuator */ public void setAttenuator(NXattenuator attenuator); /** * Get a NXattenuator node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXattenuator for that node. */ public NXattenuator getAttenuator(String name); /** * Set a NXattenuator node by name: *
    *
  • *
* * @param name the name of the node * @param attenuator the value to set */ public void setAttenuator(String name, NXattenuator attenuator); /** * Get all NXattenuator nodes: *
    *
  • *
* * @return a map from node names to the NXattenuator for that node. */ public Map getAllAttenuator(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param attenuator the child nodes to add */ public void setAllAttenuator(Map attenuator); /** * * @return the value. */ public NXbeam getBeam(); /** * * @param beam the beam */ public void setBeam(NXbeam beam); /** * Get a NXbeam node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXbeam for that node. */ public NXbeam getBeam(String name); /** * Set a NXbeam node by name: *
    *
  • *
* * @param name the name of the node * @param beam the value to set */ public void setBeam(String name, NXbeam beam); /** * Get all NXbeam nodes: *
    *
  • *
* * @return a map from node names to the NXbeam for that node. */ public Map getAllBeam(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param beam the child nodes to add */ public void setAllBeam(Map beam); /** * * @return the value. */ public NXbeam_stop getBeam_stop(); /** * * @param beam_stop the beam_stop */ public void setBeam_stop(NXbeam_stop beam_stop); /** * Get a NXbeam_stop node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXbeam_stop for that node. */ public NXbeam_stop getBeam_stop(String name); /** * Set a NXbeam_stop node by name: *
    *
  • *
* * @param name the name of the node * @param beam_stop the value to set */ public void setBeam_stop(String name, NXbeam_stop beam_stop); /** * Get all NXbeam_stop nodes: *
    *
  • *
* * @return a map from node names to the NXbeam_stop for that node. */ public Map getAllBeam_stop(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param beam_stop the child nodes to add */ public void setAllBeam_stop(Map beam_stop); /** * * @return the value. */ public NXbending_magnet getBending_magnet(); /** * * @param bending_magnet the bending_magnet */ public void setBending_magnet(NXbending_magnet bending_magnet); /** * Get a NXbending_magnet node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXbending_magnet for that node. */ public NXbending_magnet getBending_magnet(String name); /** * Set a NXbending_magnet node by name: *
    *
  • *
* * @param name the name of the node * @param bending_magnet the value to set */ public void setBending_magnet(String name, NXbending_magnet bending_magnet); /** * Get all NXbending_magnet nodes: *
    *
  • *
* * @return a map from node names to the NXbending_magnet for that node. */ public Map getAllBending_magnet(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param bending_magnet the child nodes to add */ public void setAllBending_magnet(Map bending_magnet); /** * * @return the value. */ public NXcollimator getCollimator(); /** * * @param collimator the collimator */ public void setCollimator(NXcollimator collimator); /** * Get a NXcollimator node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXcollimator for that node. */ public NXcollimator getCollimator(String name); /** * Set a NXcollimator node by name: *
    *
  • *
* * @param name the name of the node * @param collimator the value to set */ public void setCollimator(String name, NXcollimator collimator); /** * Get all NXcollimator nodes: *
    *
  • *
* * @return a map from node names to the NXcollimator for that node. */ public Map getAllCollimator(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param collimator the child nodes to add */ public void setAllCollimator(Map collimator); /** * * @return the value. */ public NXcollection getCollection(); /** * * @param collection the collection */ public void setCollection(NXcollection collection); /** * Get a NXcollection node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXcollection for that node. */ public NXcollection getCollection(String name); /** * Set a NXcollection node by name: *
    *
  • *
* * @param name the name of the node * @param collection the value to set */ public void setCollection(String name, NXcollection collection); /** * Get all NXcollection nodes: *
    *
  • *
* * @return a map from node names to the NXcollection for that node. */ public Map getAllCollection(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param collection the child nodes to add */ public void setAllCollection(Map collection); /** * * @return the value. */ public NXcapillary getCapillary(); /** * * @param capillary the capillary */ public void setCapillary(NXcapillary capillary); /** * Get a NXcapillary node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXcapillary for that node. */ public NXcapillary getCapillary(String name); /** * Set a NXcapillary node by name: *
    *
  • *
* * @param name the name of the node * @param capillary the value to set */ public void setCapillary(String name, NXcapillary capillary); /** * Get all NXcapillary nodes: *
    *
  • *
* * @return a map from node names to the NXcapillary for that node. */ public Map getAllCapillary(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param capillary the child nodes to add */ public void setAllCapillary(Map capillary); /** * * @return the value. */ public NXcrystal getCrystal(); /** * * @param crystal the crystal */ public void setCrystal(NXcrystal crystal); /** * Get a NXcrystal node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXcrystal for that node. */ public NXcrystal getCrystal(String name); /** * Set a NXcrystal node by name: *
    *
  • *
* * @param name the name of the node * @param crystal the value to set */ public void setCrystal(String name, NXcrystal crystal); /** * Get all NXcrystal nodes: *
    *
  • *
* * @return a map from node names to the NXcrystal for that node. */ public Map getAllCrystal(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param crystal the child nodes to add */ public void setAllCrystal(Map crystal); /** * * @return the value. */ public NXdetector getDetector(); /** * * @param detector the detector */ public void setDetector(NXdetector detector); /** * Get a NXdetector node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXdetector for that node. */ public NXdetector getDetector(String name); /** * Set a NXdetector node by name: *
    *
  • *
* * @param name the name of the node * @param detector the value to set */ public void setDetector(String name, NXdetector detector); /** * Get all NXdetector nodes: *
    *
  • *
* * @return a map from node names to the NXdetector for that node. */ public Map getAllDetector(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param detector the child nodes to add */ public void setAllDetector(Map detector); /** * * @return the value. */ public NXdetector_group getDetector_group(); /** * * @param detector_group the detector_group */ public void setDetector_group(NXdetector_group detector_group); /** * Get a NXdetector_group node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXdetector_group for that node. */ public NXdetector_group getDetector_group(String name); /** * Set a NXdetector_group node by name: *
    *
  • *
* * @param name the name of the node * @param detector_group the value to set */ public void setDetector_group(String name, NXdetector_group detector_group); /** * Get all NXdetector_group nodes: *
    *
  • *
* * @return a map from node names to the NXdetector_group for that node. */ public Map getAllDetector_group(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param detector_group the child nodes to add */ public void setAllDetector_group(Map detector_group); /** * * @return the value. */ public NXdisk_chopper getDisk_chopper(); /** * * @param disk_chopper the disk_chopper */ public void setDisk_chopper(NXdisk_chopper disk_chopper); /** * Get a NXdisk_chopper node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXdisk_chopper for that node. */ public NXdisk_chopper getDisk_chopper(String name); /** * Set a NXdisk_chopper node by name: *
    *
  • *
* * @param name the name of the node * @param disk_chopper the value to set */ public void setDisk_chopper(String name, NXdisk_chopper disk_chopper); /** * Get all NXdisk_chopper nodes: *
    *
  • *
* * @return a map from node names to the NXdisk_chopper for that node. */ public Map getAllDisk_chopper(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param disk_chopper the child nodes to add */ public void setAllDisk_chopper(Map disk_chopper); /** * * @return the value. */ public NXevent_data getEvent_data(); /** * * @param event_data the event_data */ public void setEvent_data(NXevent_data event_data); /** * Get a NXevent_data node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXevent_data for that node. */ public NXevent_data getEvent_data(String name); /** * Set a NXevent_data node by name: *
    *
  • *
* * @param name the name of the node * @param event_data the value to set */ public void setEvent_data(String name, NXevent_data event_data); /** * Get all NXevent_data nodes: *
    *
  • *
* * @return a map from node names to the NXevent_data for that node. */ public Map getAllEvent_data(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param event_data the child nodes to add */ public void setAllEvent_data(Map event_data); /** * * @return the value. */ public NXfermi_chopper getFermi_chopper(); /** * * @param fermi_chopper the fermi_chopper */ public void setFermi_chopper(NXfermi_chopper fermi_chopper); /** * Get a NXfermi_chopper node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXfermi_chopper for that node. */ public NXfermi_chopper getFermi_chopper(String name); /** * Set a NXfermi_chopper node by name: *
    *
  • *
* * @param name the name of the node * @param fermi_chopper the value to set */ public void setFermi_chopper(String name, NXfermi_chopper fermi_chopper); /** * Get all NXfermi_chopper nodes: *
    *
  • *
* * @return a map from node names to the NXfermi_chopper for that node. */ public Map getAllFermi_chopper(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param fermi_chopper the child nodes to add */ public void setAllFermi_chopper(Map fermi_chopper); /** * * @return the value. */ public NXfilter getFilter(); /** * * @param filter the filter */ public void setFilter(NXfilter filter); /** * Get a NXfilter node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXfilter for that node. */ public NXfilter getFilter(String name); /** * Set a NXfilter node by name: *
    *
  • *
* * @param name the name of the node * @param filter the value to set */ public void setFilter(String name, NXfilter filter); /** * Get all NXfilter nodes: *
    *
  • *
* * @return a map from node names to the NXfilter for that node. */ public Map getAllFilter(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param filter the child nodes to add */ public void setAllFilter(Map filter); /** * * @return the value. */ public NXflipper getFlipper(); /** * * @param flipper the flipper */ public void setFlipper(NXflipper flipper); /** * Get a NXflipper node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXflipper for that node. */ public NXflipper getFlipper(String name); /** * Set a NXflipper node by name: *
    *
  • *
* * @param name the name of the node * @param flipper the value to set */ public void setFlipper(String name, NXflipper flipper); /** * Get all NXflipper nodes: *
    *
  • *
* * @return a map from node names to the NXflipper for that node. */ public Map getAllFlipper(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param flipper the child nodes to add */ public void setAllFlipper(Map flipper); /** * * @return the value. */ public NXguide getGuide(); /** * * @param guide the guide */ public void setGuide(NXguide guide); /** * Get a NXguide node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXguide for that node. */ public NXguide getGuide(String name); /** * Set a NXguide node by name: *
    *
  • *
* * @param name the name of the node * @param guide the value to set */ public void setGuide(String name, NXguide guide); /** * Get all NXguide nodes: *
    *
  • *
* * @return a map from node names to the NXguide for that node. */ public Map getAllGuide(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param guide the child nodes to add */ public void setAllGuide(Map guide); /** * * @return the value. */ public NXinsertion_device getInsertion_device(); /** * * @param insertion_device the insertion_device */ public void setInsertion_device(NXinsertion_device insertion_device); /** * Get a NXinsertion_device node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXinsertion_device for that node. */ public NXinsertion_device getInsertion_device(String name); /** * Set a NXinsertion_device node by name: *
    *
  • *
* * @param name the name of the node * @param insertion_device the value to set */ public void setInsertion_device(String name, NXinsertion_device insertion_device); /** * Get all NXinsertion_device nodes: *
    *
  • *
* * @return a map from node names to the NXinsertion_device for that node. */ public Map getAllInsertion_device(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param insertion_device the child nodes to add */ public void setAllInsertion_device(Map insertion_device); /** * * @return the value. */ public NXmirror getMirror(); /** * * @param mirror the mirror */ public void setMirror(NXmirror mirror); /** * Get a NXmirror node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXmirror for that node. */ public NXmirror getMirror(String name); /** * Set a NXmirror node by name: *
    *
  • *
* * @param name the name of the node * @param mirror the value to set */ public void setMirror(String name, NXmirror mirror); /** * Get all NXmirror nodes: *
    *
  • *
* * @return a map from node names to the NXmirror for that node. */ public Map getAllMirror(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param mirror the child nodes to add */ public void setAllMirror(Map mirror); /** * * @return the value. */ public NXmoderator getModerator(); /** * * @param moderator the moderator */ public void setModerator(NXmoderator moderator); /** * Get a NXmoderator node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXmoderator for that node. */ public NXmoderator getModerator(String name); /** * Set a NXmoderator node by name: *
    *
  • *
* * @param name the name of the node * @param moderator the value to set */ public void setModerator(String name, NXmoderator moderator); /** * Get all NXmoderator nodes: *
    *
  • *
* * @return a map from node names to the NXmoderator for that node. */ public Map getAllModerator(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param moderator the child nodes to add */ public void setAllModerator(Map moderator); /** * * @return the value. */ public NXmonochromator getMonochromator(); /** * * @param monochromator the monochromator */ public void setMonochromator(NXmonochromator monochromator); /** * Get a NXmonochromator node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXmonochromator for that node. */ public NXmonochromator getMonochromator(String name); /** * Set a NXmonochromator node by name: *
    *
  • *
* * @param name the name of the node * @param monochromator the value to set */ public void setMonochromator(String name, NXmonochromator monochromator); /** * Get all NXmonochromator nodes: *
    *
  • *
* * @return a map from node names to the NXmonochromator for that node. */ public Map getAllMonochromator(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param monochromator the child nodes to add */ public void setAllMonochromator(Map monochromator); /** * * @return the value. */ public NXpolarizer getPolarizer(); /** * * @param polarizer the polarizer */ public void setPolarizer(NXpolarizer polarizer); /** * Get a NXpolarizer node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXpolarizer for that node. */ public NXpolarizer getPolarizer(String name); /** * Set a NXpolarizer node by name: *
    *
  • *
* * @param name the name of the node * @param polarizer the value to set */ public void setPolarizer(String name, NXpolarizer polarizer); /** * Get all NXpolarizer nodes: *
    *
  • *
* * @return a map from node names to the NXpolarizer for that node. */ public Map getAllPolarizer(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param polarizer the child nodes to add */ public void setAllPolarizer(Map polarizer); /** * * @return the value. */ public NXpositioner getPositioner(); /** * * @param positioner the positioner */ public void setPositioner(NXpositioner positioner); /** * Get a NXpositioner node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXpositioner for that node. */ public NXpositioner getPositioner(String name); /** * Set a NXpositioner node by name: *
    *
  • *
* * @param name the name of the node * @param positioner the value to set */ public void setPositioner(String name, NXpositioner positioner); /** * Get all NXpositioner nodes: *
    *
  • *
* * @return a map from node names to the NXpositioner for that node. */ public Map getAllPositioner(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param positioner the child nodes to add */ public void setAllPositioner(Map positioner); /** * * @return the value. */ public NXsource getSource(); /** * * @param source the source */ public void setSource(NXsource source); /** * Get a NXsource node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXsource for that node. */ public NXsource getSource(String name); /** * Set a NXsource node by name: *
    *
  • *
* * @param name the name of the node * @param source the value to set */ public void setSource(String name, NXsource source); /** * Get all NXsource nodes: *
    *
  • *
* * @return a map from node names to the NXsource for that node. */ public Map getAllSource(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param source the child nodes to add */ public void setAllSource(Map source); /** * * @return the value. */ public NXvelocity_selector getVelocity_selector(); /** * * @param velocity_selector the velocity_selector */ public void setVelocity_selector(NXvelocity_selector velocity_selector); /** * Get a NXvelocity_selector node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXvelocity_selector for that node. */ public NXvelocity_selector getVelocity_selector(String name); /** * Set a NXvelocity_selector node by name: *
    *
  • *
* * @param name the name of the node * @param velocity_selector the value to set */ public void setVelocity_selector(String name, NXvelocity_selector velocity_selector); /** * Get all NXvelocity_selector nodes: *
    *
  • *
* * @return a map from node names to the NXvelocity_selector for that node. */ public Map getAllVelocity_selector(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param velocity_selector the child nodes to add */ public void setAllVelocity_selector(Map velocity_selector); /** * * @return the value. */ public NXxraylens getXraylens(); /** * * @param xraylens the xraylens */ public void setXraylens(NXxraylens xraylens); /** * Get a NXxraylens node by name: *
    *
  • *
* * @param name the name of the node. * @return a map from node names to the NXxraylens for that node. */ public NXxraylens getXraylens(String name); /** * Set a NXxraylens node by name: *
    *
  • *
* * @param name the name of the node * @param xraylens the value to set */ public void setXraylens(String name, NXxraylens xraylens); /** * Get all NXxraylens nodes: *
    *
  • *
* * @return a map from node names to the NXxraylens for that node. */ public Map getAllXraylens(); /** * Set multiple child nodes of a particular type. *
    *
  • *
* * @param xraylens the child nodes to add */ public void setAllXraylens(Map xraylens); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy