generated.docs.javadoc.org.eclipse.dawnsci.nexus.impl.NXtranslationImpl.html Maven / Gradle / Ivy






NXtranslationImpl (h5jan API)











Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.nexus.impl
Class NXtranslationImpl



java.lang.Object


org.eclipse.dawnsci.analysis.tree.impl.NodeImpl


org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl


org.eclipse.dawnsci.nexus.impl.NXobjectImpl


org.eclipse.dawnsci.nexus.impl.NXtranslationImpl













All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXobject, NXtranslation




public class NXtranslationImpl
extends NXobjectImpl
implements NXtranslation
legacy class - (used by :ref:`NXgeometry`) - general spatial location of a component.

See Also:
Serialized Form












Field Summary

Fields 

Modifier and Type
Field and Description


static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES 






Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS





Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT





Fields inherited from interface org.eclipse.dawnsci.nexus.NXtranslation
NX_DISTANCES





Fields inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
ATTRIBUTE, SEPARATOR








Constructor Summary

Constructors 

Constructor and Description


NXtranslationImpl() 


NXtranslationImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getDistances()
(x,y,z)
 This field describes the lateral movement of a component.



java.lang.Double
getDistancesScalar()
(x,y,z)
 This field describes the lateral movement of a component.



NXgeometry
getGeometry()
Link to other object if we are relative, else absent



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



DataNode
setDistances(IDataset distances)
(x,y,z)
 This field describes the lateral movement of a component.



DataNode
setDistancesScalar(java.lang.Double distances)
(x,y,z)
 This field describes the lateral movement of a component.



void
setGeometry(NXgeometry geometry)
Link to other object if we are relative, else absent







Methods inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, createNodeLink, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isGroupNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool, toString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait





Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setField





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode





Methods inherited from interface java.lang.Iterable
forEach, spliterator














Field Detail





PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES









Constructor Detail





NXtranslationImpl
public NXtranslationImpl()







NXtranslationImpl
public NXtranslationImpl(long oid)









Method Detail





getNXclass
public java.lang.Class<? extends NXobject> getNXclass()
Description copied from interface: NXobject
Java Class object of the interface for this base class, e.g. NXsample.class.

Specified by:
getNXclass in interface NXobject
Returns:
name of Nexus class








getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass for this base class, e.g. NexusBaseClass.NX_SAMPLE.

Specified by:
getNexusBaseClass in interface NXobject
Returns:
NexusBaseClass enum constant for this class








getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.

Specified by:
getPermittedChildGroupClasses in interface NXobject
Returns:
NexusBaseClass constants for permitted child groups








getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXtranslation
Link to other object if we are relative, else absent

Specified by:
getGeometry in interface NXtranslation
Returns:
the value.








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXtranslation
Link to other object if we are relative, else absent

Specified by:
setGeometry in interface NXtranslation
Parameters:
geometry - the geometry








getDistances
public IDataset getDistances()
Description copied from interface: NXtranslation
(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;
 

Specified by:
getDistances in interface NXtranslation
Returns:
the value.








getDistancesScalar
public java.lang.Double getDistancesScalar()
Description copied from interface: NXtranslation
(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;
 

Specified by:
getDistancesScalar in interface NXtranslation
Returns:
the value.








setDistances
public DataNode setDistances(IDataset distances)
Description copied from interface: NXtranslation
(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;
 

Specified by:
setDistances in interface NXtranslation
Parameters:
distances - the distances








setDistancesScalar
public DataNode setDistancesScalar(java.lang.Double distances)
Description copied from interface: NXtranslation
(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;
 

Specified by:
setDistancesScalar in interface NXtranslation
Parameters:
distances - the distances














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method
Modifier and Type	Method and Description
`IDataset`	`getDistances()` (x,y,z) This field describes the lateral movement of a component.
`java.lang.Double`	`getDistancesScalar()` (x,y,z) This field describes the lateral movement of a component.
`NXgeometry`	`getGeometry()` Link to other object if we are relative, else absent
`NexusBaseClass`	`getNexusBaseClass()` Enum constant from `NexusBaseClass` for this base class, e.g.
`java.lang.Class<? extends NXobject>`	`getNXclass()` Java `Class` object of the interface for this base class, e.g.
`java.util.Set<NexusBaseClass>`	`getPermittedChildGroupClasses()` Returns a set containing the `NexusBaseClass` constants for the permitted child group types of this base class.
`DataNode`	`setDistances(IDataset distances)` (x,y,z) This field describes the lateral movement of a component.
`DataNode`	`setDistancesScalar(java.lang.Double distances)` (x,y,z) This field describes the lateral movement of a component.
`void`	`setGeometry(NXgeometry geometry)` Link to other object if we are relative, else absent
Constructors
Constructor and Description
`NXtranslationImpl()`
`NXtranslationImpl(long oid)`