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






NXorientation (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
Interface NXorientation






All Superinterfaces:
GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject


All Known Implementing Classes:
NXorientationImpl




public interface NXorientation
extends NXobject
legacy class - recommend to use :ref:`NXtransformations` now
 Description for a general orientation of a component - used by :ref:`NXgeometry`











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_VALUE 






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








Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
 
 
 Link to another object if we are using relative positioning, else absent
 



NXgeometry
getGeometry()
Link to another object if we are using relative positioning, else absent



NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 Link to another object if we are using relative positioning, else absent
 



IDataset
getValue()
The orientation information is stored as direction cosines.



java.lang.Double
getValueScalar()
The orientation information is stored as direction cosines.



void
setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.



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



void
setGeometry(java.lang.String name,
           NXgeometry geometry)
Set a NXgeometry node by name:
 
 
 Link to another object if we are using relative positioning, else absent
 



DataNode
setValue(IDataset value)
The orientation information is stored as direction cosines.



DataNode
setValueScalar(java.lang.Double value)
The orientation information is stored as direction cosines.







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, getNexusBaseClass, getNumber, getNXclass, getPermittedChildGroupClasses, 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





NX_VALUE
static final java.lang.String NX_VALUE

See Also:
Constant Field Values










Method Detail





getGeometry
NXgeometry getGeometry()
Link to another object if we are using relative positioning, else absent

Returns:
the value.








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

Parameters:
geometry - the geometry








getGeometry
NXgeometry getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 Link to another object if we are using relative positioning, else absent
 

Parameters:
name - the name of the node.
Returns:
a map from node names to the NXgeometry for that node.








setGeometry
void setGeometry(java.lang.String name,
                 NXgeometry geometry)
Set a NXgeometry node by name:
 
 
 Link to another object if we are using relative positioning, else absent
 

Parameters:
name - the name of the node
geometry - the value to set








getAllGeometry
java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Get all NXgeometry nodes:
 
 
 Link to another object if we are using relative positioning, else absent
 

Returns:
a map from node names to the NXgeometry for that node.








setAllGeometry
void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.
 
 
 Link to another object if we are using relative positioning, else absent
 

Parameters:
geometry - the child nodes to add








getValue
IDataset getValue()
The orientation information is stored as direction cosines. The direction cosines will
 be between the local coordinate directions and the reference directions (to origin or
 relative NXgeometry). Calling the local unit vectors (x',y',z') and the reference unit
 vectors (x,y,z) the six numbers will be [x' dot x, x' dot y, x' dot z, y' dot x, y' dot
 y, y' dot z] where "dot" is the scalar dot product (cosine of the angle between the unit
 vectors). The unit vectors in both the local and reference coordinates are right-handed
 and orthonormal.
 The pair of groups NXtranslation and NXorientation together
 describe the position of a component.
 
 Type: NX_FLOAT
 Units: NX_UNITLESS
 Dimensions: 1: numobj; 2: 6;
 

Returns:
the value.








setValue
DataNode setValue(IDataset value)
The orientation information is stored as direction cosines. The direction cosines will
 be between the local coordinate directions and the reference directions (to origin or
 relative NXgeometry). Calling the local unit vectors (x',y',z') and the reference unit
 vectors (x,y,z) the six numbers will be [x' dot x, x' dot y, x' dot z, y' dot x, y' dot
 y, y' dot z] where "dot" is the scalar dot product (cosine of the angle between the unit
 vectors). The unit vectors in both the local and reference coordinates are right-handed
 and orthonormal.
 The pair of groups NXtranslation and NXorientation together
 describe the position of a component.
 
 Type: NX_FLOAT
 Units: NX_UNITLESS
 Dimensions: 1: numobj; 2: 6;
 

Parameters:
value - the value








getValueScalar
java.lang.Double getValueScalar()
The orientation information is stored as direction cosines. The direction cosines will
 be between the local coordinate directions and the reference directions (to origin or
 relative NXgeometry). Calling the local unit vectors (x',y',z') and the reference unit
 vectors (x,y,z) the six numbers will be [x' dot x, x' dot y, x' dot z, y' dot x, y' dot
 y, y' dot z] where "dot" is the scalar dot product (cosine of the angle between the unit
 vectors). The unit vectors in both the local and reference coordinates are right-handed
 and orthonormal.
 The pair of groups NXtranslation and NXorientation together
 describe the position of a component.
 
 Type: NX_FLOAT
 Units: NX_UNITLESS
 Dimensions: 1: numobj; 2: 6;
 

Returns:
the value.








setValueScalar
DataNode setValueScalar(java.lang.Double value)
The orientation information is stored as direction cosines. The direction cosines will
 be between the local coordinate directions and the reference directions (to origin or
 relative NXgeometry). Calling the local unit vectors (x',y',z') and the reference unit
 vectors (x,y,z) the six numbers will be [x' dot x, x' dot y, x' dot z, y' dot x, y' dot
 y, y' dot z] where "dot" is the scalar dot product (cosine of the angle between the unit
 vectors). The unit vectors in both the local and reference coordinates are right-handed
 and orthonormal.
 The pair of groups NXtranslation and NXorientation together
 describe the position of a component.
 
 Type: NX_FLOAT
 Units: NX_UNITLESS
 Dimensions: 1: numobj; 2: 6;
 

Parameters:
value - the value














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
`java.util.Map<java.lang.String,NXgeometry>`	`getAllGeometry()` Get all NXgeometry nodes: Link to another object if we are using relative positioning, else absent
`NXgeometry`	`getGeometry()` Link to another object if we are using relative positioning, else absent
`NXgeometry`	`getGeometry(java.lang.String name)` Get a NXgeometry node by name: Link to another object if we are using relative positioning, else absent
`IDataset`	`getValue()` The orientation information is stored as direction cosines.
`java.lang.Double`	`getValueScalar()` The orientation information is stored as direction cosines.
`void`	`setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)` Set multiple child nodes of a particular type.
`void`	`setGeometry(NXgeometry geometry)` Link to another object if we are using relative positioning, else absent
`void`	`setGeometry(java.lang.String name, NXgeometry geometry)` Set a NXgeometry node by name: Link to another object if we are using relative positioning, else absent
`DataNode`	`setValue(IDataset value)` The orientation information is stored as direction cosines.
`DataNode`	`setValueScalar(java.lang.Double value)` The orientation information is stored as direction cosines.