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

/**
 * legacy class - recommend to use :ref:`NXtransformations` now
 * It is recommended that instances of :ref:`NXgeometry` be converted to
 * use :ref:`NXtransformations`.
 * This is the description for a general position of a component.
 * It is recommended to name an instance of :ref:`NXgeometry` as "geometry"
 * to aid in the use of the definition in simulation codes such as McStas.
 * Also, in HDF, linked items must share the same name.
 * However, it might not be possible or practical in all situations.
 * 
 * @deprecated as decided at 2014 NIAC meeting, convert to use :ref:`NXtransformations`
 */
@Deprecated
public interface NXgeometry extends NXobject {

	public static final String NX_DESCRIPTION = "description";
	public static final String NX_COMPONENT_INDEX = "component_index";
	/**
	 * shape/size information of component
	 * 
	 * @return  the value.
	 */
	public NXshape getShape();
	
	/**
	 * shape/size information of component
	 * 
	 * @param shape the shape
	 */
	public void setShape(NXshape shape);
  
	/**
	 * Get a NXshape node by name:
	 * 
	 * 
	 * shape/size information of component
	 * 
	 * 
	 * @param name  the name of the node.
	 * @return  a map from node names to the NXshape for that node.
	 */
	public NXshape getShape(String name);
	
	/**
	 * Set a NXshape node by name:
	 * 
	 * 
	 * shape/size information of component
	 * 
	 * 
	 * @param name the name of the node
	 * @param shape the value to set
	 */
	public void setShape(String name, NXshape shape);
	
	/**
	 * Get all NXshape nodes:
	 * 
	 * 
	 * shape/size information of component
	 * 
	 * 
	 * @return  a map from node names to the NXshape for that node.
	 */
	public Map getAllShape();
	
	/**
	 * Set multiple child nodes of a particular type.
	 * 
	 * 
	 * shape/size information of component
	 * 
	 * 
	 * @param shape the child nodes to add 
	 */
	
	public void setAllShape(Map shape);
	

	/**
	 * translation of component
	 * 
	 * @return  the value.
	 */
	public NXtranslation getTranslation();
	
	/**
	 * translation of component
	 * 
	 * @param translation the translation
	 */
	public void setTranslation(NXtranslation translation);
  
	/**
	 * Get a NXtranslation node by name:
	 * 
	 * 
	 * translation of component
	 * 
	 * 
	 * @param name  the name of the node.
	 * @return  a map from node names to the NXtranslation for that node.
	 */
	public NXtranslation getTranslation(String name);
	
	/**
	 * Set a NXtranslation node by name:
	 * 
	 * 
	 * translation of component
	 * 
	 * 
	 * @param name the name of the node
	 * @param translation the value to set
	 */
	public void setTranslation(String name, NXtranslation translation);
	
	/**
	 * Get all NXtranslation nodes:
	 * 
	 * 
	 * translation of component
	 * 
	 * 
	 * @return  a map from node names to the NXtranslation for that node.
	 */
	public Map getAllTranslation();
	
	/**
	 * Set multiple child nodes of a particular type.
	 * 
	 * 
	 * translation of component
	 * 
	 * 
	 * @param translation the child nodes to add 
	 */
	
	public void setAllTranslation(Map translation);
	

	/**
	 * orientation of component
	 * 
	 * @return  the value.
	 */
	public NXorientation getOrientation();
	
	/**
	 * orientation of component
	 * 
	 * @param orientation the orientation
	 */
	public void setOrientation(NXorientation orientation);
  
	/**
	 * Get a NXorientation node by name:
	 * 
	 * 
	 * orientation of component
	 * 
	 * 
	 * @param name  the name of the node.
	 * @return  a map from node names to the NXorientation for that node.
	 */
	public NXorientation getOrientation(String name);
	
	/**
	 * Set a NXorientation node by name:
	 * 
	 * 
	 * orientation of component
	 * 
	 * 
	 * @param name the name of the node
	 * @param orientation the value to set
	 */
	public void setOrientation(String name, NXorientation orientation);
	
	/**
	 * Get all NXorientation nodes:
	 * 
	 * 
	 * orientation of component
	 * 
	 * 
	 * @return  a map from node names to the NXorientation for that node.
	 */
	public Map getAllOrientation();
	
	/**
	 * Set multiple child nodes of a particular type.
	 * 
	 * 
	 * orientation of component
	 * 
	 * 
	 * @param orientation the child nodes to add 
	 */
	
	public void setAllOrientation(Map orientation);
	

	/**
	 * Optional description/label. Probably only present if we are
	 * an additional reference point for components rather than the
	 * location of a real component.
	 * 
	 * @return  the value.
	 */
	public IDataset getDescription();
	
	/**
	 * Optional description/label. Probably only present if we are
	 * an additional reference point for components rather than the
	 * location of a real component.
	 * 
	 * @param description the description
	 */
	public DataNode setDescription(IDataset description);

	/**
	 * Optional description/label. Probably only present if we are
	 * an additional reference point for components rather than the
	 * location of a real component.
	 * 
	 * @return  the value.
	 */
	public String getDescriptionScalar();

	/**
	 * Optional description/label. Probably only present if we are
	 * an additional reference point for components rather than the
	 * location of a real component.
	 * 
	 * @param description the description
	 */
	public DataNode setDescriptionScalar(String description);

	/**
	 * Position of the component along the beam path. The sample is at 0, components upstream
	 * have negative component_index, components downstream have positive
	 * component_index.
	 * 
	 * Type: NX_INT
	 * 
	 * 
	 * @return  the value.
	 */
	public IDataset getComponent_index();
	
	/**
	 * Position of the component along the beam path. The sample is at 0, components upstream
	 * have negative component_index, components downstream have positive
	 * component_index.
	 * 
	 * Type: NX_INT
	 * 
	 * 
	 * @param component_index the component_index
	 */
	public DataNode setComponent_index(IDataset component_index);

	/**
	 * Position of the component along the beam path. The sample is at 0, components upstream
	 * have negative component_index, components downstream have positive
	 * component_index.
	 * 
	 * Type: NX_INT
	 * 
	 * 
	 * @return  the value.
	 */
	public Long getComponent_indexScalar();

	/**
	 * Position of the component along the beam path. The sample is at 0, components upstream
	 * have negative component_index, components downstream have positive
	 * component_index.
	 * 
	 * Type: NX_INT
	 * 
	 * 
	 * @param component_index the component_index
	 */
	public DataNode setComponent_indexScalar(Long component_index);

}