org.eclipse.dawnsci.nexus.NXtranslation 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 org.eclipse.dawnsci.analysis.api.tree.DataNode;
import org.eclipse.january.dataset.IDataset;
/**
* legacy class - (used by :ref:`NXgeometry`) - general spatial location of a component.
*
*/
public interface NXtranslation extends NXobject {
public static final String NX_DISTANCES = "distances";
/**
* Link to other object if we are relative, else absent
*
* @return the value.
*/
public NXgeometry getGeometry();
/**
* Link to other object if we are relative, else absent
*
* @param geometry the geometry
*/
public void setGeometry(NXgeometry geometry);
/**
* (x,y,z)
* This field describes the lateral movement of a component.
* The pair of groups NXtranslation and NXorientation together
* describe the position of a component.
* For absolute position, the origin is the scattering center (where a perfectly
* aligned sample would be) with the z-axis pointing downstream and the y-axis
* pointing gravitationally up. For a relative position the NXtranslation is
* taken into account before the NXorientation. The axes are right-handed and
* orthonormal.
*
* Type: NX_FLOAT
* Units: NX_LENGTH
* Dimensions: 1: numobj; 2: 3;
*
*
* @return the value.
*/
public IDataset getDistances();
/**
* (x,y,z)
* This field describes the lateral movement of a component.
* The pair of groups NXtranslation and NXorientation together
* describe the position of a component.
* For absolute position, the origin is the scattering center (where a perfectly
* aligned sample would be) with the z-axis pointing downstream and the y-axis
* pointing gravitationally up. For a relative position the NXtranslation is
* taken into account before the NXorientation. The axes are right-handed and
* orthonormal.
*
* Type: NX_FLOAT
* Units: NX_LENGTH
* Dimensions: 1: numobj; 2: 3;
*
*
* @param distances the distances
*/
public DataNode setDistances(IDataset distances);
/**
* (x,y,z)
* This field describes the lateral movement of a component.
* The pair of groups NXtranslation and NXorientation together
* describe the position of a component.
* For absolute position, the origin is the scattering center (where a perfectly
* aligned sample would be) with the z-axis pointing downstream and the y-axis
* pointing gravitationally up. For a relative position the NXtranslation is
* taken into account before the NXorientation. The axes are right-handed and
* orthonormal.
*
* Type: NX_FLOAT
* Units: NX_LENGTH
* Dimensions: 1: numobj; 2: 3;
*
*
* @return the value.
*/
public Double getDistancesScalar();
/**
* (x,y,z)
* This field describes the lateral movement of a component.
* The pair of groups NXtranslation and NXorientation together
* describe the position of a component.
* For absolute position, the origin is the scattering center (where a perfectly
* aligned sample would be) with the z-axis pointing downstream and the y-axis
* pointing gravitationally up. For a relative position the NXtranslation is
* taken into account before the NXorientation. The axes are right-handed and
* orthonormal.
*
* Type: NX_FLOAT
* Units: NX_LENGTH
* Dimensions: 1: numobj; 2: 3;
*
*
* @param distances the distances
*/
public DataNode setDistancesScalar(Double distances);
}