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






NXorientationImpl (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 NXorientationImpl



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.NXorientationImpl













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




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

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.NXorientation
NX_VALUE





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








Constructor Summary

Constructors 

Constructor and Description


NXorientationImpl() 


NXorientationImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete 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
 



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.



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 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





NXorientationImpl
public NXorientationImpl()







NXorientationImpl
public NXorientationImpl(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: NXorientation
Link to another object if we are using relative positioning, else absent

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








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXorientation
Link to another object if we are using relative positioning, else absent

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








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

Specified by:
getGeometry in interface NXorientation
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXgeometry for that node.








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

Specified by:
setGeometry in interface NXorientation
Parameters:
name - the name of the node
geometry - the value to set








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

Specified by:
getAllGeometry in interface NXorientation
Returns:
a map from node names to the NXgeometry for that node.








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

Specified by:
setAllGeometry in interface NXorientation
Parameters:
geometry - the child nodes to add








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

Specified by:
getValue in interface NXorientation
Returns:
the value.








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

Specified by:
getValueScalar in interface NXorientation
Returns:
the value.








setValue
public DataNode setValue(IDataset value)
Description copied from interface: NXorientation
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;
 

Specified by:
setValue in interface NXorientation
Parameters:
value - the value








setValueScalar
public DataNode setValueScalar(java.lang.Double value)
Description copied from interface: NXorientation
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;
 

Specified by:
setValueScalar in interface NXorientation
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
`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.
`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.

Constructors
Constructor and Description
`NXorientationImpl()`
`NXorientationImpl(long oid)`