org.eclipse.dawnsci.nexus.NXaperture 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 aperture.
*
*/
public interface NXaperture extends NXobject {
public static final String NX_MATERIAL = "material";
public static final String NX_DESCRIPTION = "description";
/**
* location and shape of aperture
* .. TODO: documentation needs improvement, contributions welcome
* * description of terms is poor and leaves much to interpretation
* * Describe what is meant by translation _here_ and ...
* * Similar throughout base classes
* * Some base classes do this much better
* * Such as where is the gap written?
*
* @return the value.
*/
public NXgeometry getGeometry();
/**
* location and shape of aperture
* .. TODO: documentation needs improvement, contributions welcome
* * description of terms is poor and leaves much to interpretation
* * Describe what is meant by translation _here_ and ...
* * Similar throughout base classes
* * Some base classes do this much better
* * Such as where is the gap written?
*
* @param geometry the geometry
*/
public void setGeometry(NXgeometry geometry);
/**
* Get a NXgeometry node by name:
*
* -
* location and shape of aperture
* .. TODO: documentation needs improvement, contributions welcome
* * description of terms is poor and leaves much to interpretation
* * Describe what is meant by translation _here_ and ...
* * Similar throughout base classes
* * Some base classes do this much better
* * Such as where is the gap written?
* -
* location and shape of each blade
*
*
* @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:
*
* -
* location and shape of aperture
* .. TODO: documentation needs improvement, contributions welcome
* * description of terms is poor and leaves much to interpretation
* * Describe what is meant by translation _here_ and ...
* * Similar throughout base classes
* * Some base classes do this much better
* * Such as where is the gap written?
* -
* location and shape of each blade
*
*
* @param name the name of the node
* @param geometry the value to set
*/
public void setGeometry(String name, NXgeometry geometry);
/**
* Get all NXgeometry nodes:
*
* -
* location and shape of aperture
* .. TODO: documentation needs improvement, contributions welcome
* * description of terms is poor and leaves much to interpretation
* * Describe what is meant by translation _here_ and ...
* * Similar throughout base classes
* * Some base classes do this much better
* * Such as where is the gap written?
* -
* location and shape of each blade
*
*
* @return a map from node names to the NXgeometry for that node.
*/
public Map getAllGeometry();
/**
* Set multiple child nodes of a particular type.
*
* -
* location and shape of aperture
* .. TODO: documentation needs improvement, contributions welcome
* * description of terms is poor and leaves much to interpretation
* * Describe what is meant by translation _here_ and ...
* * Similar throughout base classes
* * Some base classes do this much better
* * Such as where is the gap written?
* -
* location and shape of each blade
*
*
* @param geometry the child nodes to add
*/
public void setAllGeometry(Map geometry);
/**
* Absorbing material of the aperture
*
* @return the value.
*/
public IDataset getMaterial();
/**
* Absorbing material of the aperture
*
* @param material the material
*/
public DataNode setMaterial(IDataset material);
/**
* Absorbing material of the aperture
*
* @return the value.
*/
public String getMaterialScalar();
/**
* Absorbing material of the aperture
*
* @param material the material
*/
public DataNode setMaterialScalar(String material);
/**
* Description of aperture
*
* @return the value.
*/
public IDataset getDescription();
/**
* Description of aperture
*
* @param description the description
*/
public DataNode setDescription(IDataset description);
/**
* Description of aperture
*
* @return the value.
*/
public String getDescriptionScalar();
/**
* Description of aperture
*
* @param description the description
*/
public DataNode setDescriptionScalar(String description);
/**
* describe any additional information in a note*
*
* @return the value.
*/
public NXnote getNote();
/**
* describe any additional information in a note*
*
* @param note the note
*/
public void setNote(NXnote note);
/**
* Get a NXnote node by name:
*
* -
* describe any additional information in a note*
*
*
* @param name the name of the node.
* @return a map from node names to the NXnote for that node.
*/
public NXnote getNote(String name);
/**
* Set a NXnote node by name:
*
* -
* describe any additional information in a note*
*
*
* @param name the name of the node
* @param note the value to set
*/
public void setNote(String name, NXnote note);
/**
* Get all NXnote nodes:
*
* -
* describe any additional information in a note*
*
*
* @return a map from node names to the NXnote for that node.
*/
public Map getAllNote();
/**
* Set multiple child nodes of a particular type.
*
* -
* describe any additional information in a note*
*
*
* @param note the child nodes to add
*/
public void setAllNote(Map note);
}