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






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



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













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


Deprecated. 
as decided at 2014 NIAC meeting, convert to use :ref:`NXtransformations`



@Deprecated
public class NXgeometryImpl
extends NXobjectImpl
implements NXgeometry
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.

See Also:
Serialized Form












Field Summary

Fields 

Modifier and Type
Field and Description


static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES
Deprecated. 
 






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.NXgeometry
NX_COMPONENT_INDEX, NX_DESCRIPTION





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








Constructor Summary

Constructors 

Constructor and Description


NXgeometryImpl()
Deprecated. 
 


NXgeometryImpl(long oid)
Deprecated. 
 









Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXorientation>
getAllOrientation()
Deprecated. 
Get all NXorientation nodes:
 
 
 orientation of component
 



java.util.Map<java.lang.String,NXshape>
getAllShape()
Deprecated. 
Get all NXshape nodes:
 
 
 shape/size information of component
 



java.util.Map<java.lang.String,NXtranslation>
getAllTranslation()
Deprecated. 
Get all NXtranslation nodes:
 
 
 translation of component
 



IDataset
getComponent_index()
Deprecated. 
Position of the component along the beam path.



java.lang.Long
getComponent_indexScalar()
Deprecated. 
Position of the component along the beam path.



IDataset
getDescription()
Deprecated. 
Optional description/label.



java.lang.String
getDescriptionScalar()
Deprecated. 
Optional description/label.



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



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



NXorientation
getOrientation()
Deprecated. 
orientation of component



NXorientation
getOrientation(java.lang.String name)
Deprecated. 
Get a NXorientation node by name:
 
 
 orientation of component
 



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



NXshape
getShape()
Deprecated. 
shape/size information of component



NXshape
getShape(java.lang.String name)
Deprecated. 
Get a NXshape node by name:
 
 
 shape/size information of component
 



NXtranslation
getTranslation()
Deprecated. 
translation of component



NXtranslation
getTranslation(java.lang.String name)
Deprecated. 
Get a NXtranslation node by name:
 
 
 translation of component
 



void
setAllOrientation(java.util.Map<java.lang.String,NXorientation> orientation)
Deprecated. 
Set multiple child nodes of a particular type.



void
setAllShape(java.util.Map<java.lang.String,NXshape> shape)
Deprecated. 
Set multiple child nodes of a particular type.



void
setAllTranslation(java.util.Map<java.lang.String,NXtranslation> translation)
Deprecated. 
Set multiple child nodes of a particular type.



DataNode
setComponent_index(IDataset component_index)
Deprecated. 
Position of the component along the beam path.



DataNode
setComponent_indexScalar(java.lang.Long component_index)
Deprecated. 
Position of the component along the beam path.



DataNode
setDescription(IDataset description)
Deprecated. 
Optional description/label.



DataNode
setDescriptionScalar(java.lang.String description)
Deprecated. 
Optional description/label.



void
setOrientation(NXorientation orientation)
Deprecated. 
orientation of component



void
setOrientation(java.lang.String name,
              NXorientation orientation)
Deprecated. 
Set a NXorientation node by name:
 
 
 orientation of component
 



void
setShape(NXshape shape)
Deprecated. 
shape/size information of component



void
setShape(java.lang.String name,
        NXshape shape)
Deprecated. 
Set a NXshape node by name:
 
 
 shape/size information of component
 



void
setTranslation(NXtranslation translation)
Deprecated. 
translation of component



void
setTranslation(java.lang.String name,
              NXtranslation translation)
Deprecated. 
Set a NXtranslation node by name:
 
 
 translation of component
 







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









Constructor Detail





NXgeometryImpl
public NXgeometryImpl()
Deprecated. 







NXgeometryImpl
public NXgeometryImpl(long oid)
Deprecated. 









Method Detail





getNXclass
public java.lang.Class<? extends NXobject> getNXclass()
Deprecated. 
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()
Deprecated. 
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()
Deprecated. 
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








getShape
public NXshape getShape()
Deprecated. 
Description copied from interface: NXgeometry
shape/size information of component

Specified by:
getShape in interface NXgeometry
Returns:
the value.








setShape
public void setShape(NXshape shape)
Deprecated. 
Description copied from interface: NXgeometry
shape/size information of component

Specified by:
setShape in interface NXgeometry
Parameters:
shape - the shape








getShape
public NXshape getShape(java.lang.String name)
Deprecated. 
Description copied from interface: NXgeometry
Get a NXshape node by name:
 
 
 shape/size information of component
 

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








setShape
public void setShape(java.lang.String name,
                     NXshape shape)
Deprecated. 
Description copied from interface: NXgeometry
Set a NXshape node by name:
 
 
 shape/size information of component
 

Specified by:
setShape in interface NXgeometry
Parameters:
name - the name of the node
shape - the value to set








getAllShape
public java.util.Map<java.lang.String,NXshape> getAllShape()
Deprecated. 
Description copied from interface: NXgeometry
Get all NXshape nodes:
 
 
 shape/size information of component
 

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








setAllShape
public void setAllShape(java.util.Map<java.lang.String,NXshape> shape)
Deprecated. 
Description copied from interface: NXgeometry
Set multiple child nodes of a particular type.
 
 
 shape/size information of component
 

Specified by:
setAllShape in interface NXgeometry
Parameters:
shape - the child nodes to add








getTranslation
public NXtranslation getTranslation()
Deprecated. 
Description copied from interface: NXgeometry
translation of component

Specified by:
getTranslation in interface NXgeometry
Returns:
the value.








setTranslation
public void setTranslation(NXtranslation translation)
Deprecated. 
Description copied from interface: NXgeometry
translation of component

Specified by:
setTranslation in interface NXgeometry
Parameters:
translation - the translation








getTranslation
public NXtranslation getTranslation(java.lang.String name)
Deprecated. 
Description copied from interface: NXgeometry
Get a NXtranslation node by name:
 
 
 translation of component
 

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








setTranslation
public void setTranslation(java.lang.String name,
                           NXtranslation translation)
Deprecated. 
Description copied from interface: NXgeometry
Set a NXtranslation node by name:
 
 
 translation of component
 

Specified by:
setTranslation in interface NXgeometry
Parameters:
name - the name of the node
translation - the value to set








getAllTranslation
public java.util.Map<java.lang.String,NXtranslation> getAllTranslation()
Deprecated. 
Description copied from interface: NXgeometry
Get all NXtranslation nodes:
 
 
 translation of component
 

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








setAllTranslation
public void setAllTranslation(java.util.Map<java.lang.String,NXtranslation> translation)
Deprecated. 
Description copied from interface: NXgeometry
Set multiple child nodes of a particular type.
 
 
 translation of component
 

Specified by:
setAllTranslation in interface NXgeometry
Parameters:
translation - the child nodes to add








getOrientation
public NXorientation getOrientation()
Deprecated. 
Description copied from interface: NXgeometry
orientation of component

Specified by:
getOrientation in interface NXgeometry
Returns:
the value.








setOrientation
public void setOrientation(NXorientation orientation)
Deprecated. 
Description copied from interface: NXgeometry
orientation of component

Specified by:
setOrientation in interface NXgeometry
Parameters:
orientation - the orientation








getOrientation
public NXorientation getOrientation(java.lang.String name)
Deprecated. 
Description copied from interface: NXgeometry
Get a NXorientation node by name:
 
 
 orientation of component
 

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








setOrientation
public void setOrientation(java.lang.String name,
                           NXorientation orientation)
Deprecated. 
Description copied from interface: NXgeometry
Set a NXorientation node by name:
 
 
 orientation of component
 

Specified by:
setOrientation in interface NXgeometry
Parameters:
name - the name of the node
orientation - the value to set








getAllOrientation
public java.util.Map<java.lang.String,NXorientation> getAllOrientation()
Deprecated. 
Description copied from interface: NXgeometry
Get all NXorientation nodes:
 
 
 orientation of component
 

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








setAllOrientation
public void setAllOrientation(java.util.Map<java.lang.String,NXorientation> orientation)
Deprecated. 
Description copied from interface: NXgeometry
Set multiple child nodes of a particular type.
 
 
 orientation of component
 

Specified by:
setAllOrientation in interface NXgeometry
Parameters:
orientation - the child nodes to add








getDescription
public IDataset getDescription()
Deprecated. 
Description copied from interface: NXgeometry
Optional description/label. Probably only present if we are
 an additional reference point for components rather than the
 location of a real component.

Specified by:
getDescription in interface NXgeometry
Returns:
the value.








getDescriptionScalar
public java.lang.String getDescriptionScalar()
Deprecated. 
Description copied from interface: NXgeometry
Optional description/label. Probably only present if we are
 an additional reference point for components rather than the
 location of a real component.

Specified by:
getDescriptionScalar in interface NXgeometry
Returns:
the value.








setDescription
public DataNode setDescription(IDataset description)
Deprecated. 
Description copied from interface: NXgeometry
Optional description/label. Probably only present if we are
 an additional reference point for components rather than the
 location of a real component.

Specified by:
setDescription in interface NXgeometry
Parameters:
description - the description








setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Deprecated. 
Description copied from interface: NXgeometry
Optional description/label. Probably only present if we are
 an additional reference point for components rather than the
 location of a real component.

Specified by:
setDescriptionScalar in interface NXgeometry
Parameters:
description - the description








getComponent_index
public IDataset getComponent_index()
Deprecated. 
Description copied from interface: NXgeometry
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
 

Specified by:
getComponent_index in interface NXgeometry
Returns:
the value.








getComponent_indexScalar
public java.lang.Long getComponent_indexScalar()
Deprecated. 
Description copied from interface: NXgeometry
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
 

Specified by:
getComponent_indexScalar in interface NXgeometry
Returns:
the value.








setComponent_index
public DataNode setComponent_index(IDataset component_index)
Deprecated. 
Description copied from interface: NXgeometry
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
 

Specified by:
setComponent_index in interface NXgeometry
Parameters:
component_index - the component_index








setComponent_indexScalar
public DataNode setComponent_indexScalar(java.lang.Long component_index)
Deprecated. 
Description copied from interface: NXgeometry
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
 

Specified by:
setComponent_indexScalar in interface NXgeometry
Parameters:
component_index - the component_index














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,NXorientation>`	`getAllOrientation()` Deprecated. Get all NXorientation nodes: orientation of component
`java.util.Map<java.lang.String,NXshape>`	`getAllShape()` Deprecated. Get all NXshape nodes: shape/size information of component
`java.util.Map<java.lang.String,NXtranslation>`	`getAllTranslation()` Deprecated. Get all NXtranslation nodes: translation of component
`IDataset`	`getComponent_index()` Deprecated. Position of the component along the beam path.
`java.lang.Long`	`getComponent_indexScalar()` Deprecated. Position of the component along the beam path.
`IDataset`	`getDescription()` Deprecated. Optional description/label.
`java.lang.String`	`getDescriptionScalar()` Deprecated. Optional description/label.
`NexusBaseClass`	`getNexusBaseClass()` Deprecated. Enum constant from `NexusBaseClass` for this base class, e.g.
`java.lang.Class<? extends NXobject>`	`getNXclass()` Deprecated. Java `Class` object of the interface for this base class, e.g.
`NXorientation`	`getOrientation()` Deprecated. orientation of component
`NXorientation`	`getOrientation(java.lang.String name)` Deprecated. Get a NXorientation node by name: orientation of component
`java.util.Set<NexusBaseClass>`	`getPermittedChildGroupClasses()` Deprecated. Returns a set containing the `NexusBaseClass` constants for the permitted child group types of this base class.
`NXshape`	`getShape()` Deprecated. shape/size information of component
`NXshape`	`getShape(java.lang.String name)` Deprecated. Get a NXshape node by name: shape/size information of component
`NXtranslation`	`getTranslation()` Deprecated. translation of component
`NXtranslation`	`getTranslation(java.lang.String name)` Deprecated. Get a NXtranslation node by name: translation of component
`void`	`setAllOrientation(java.util.Map<java.lang.String,NXorientation> orientation)` Deprecated. Set multiple child nodes of a particular type.
`void`	`setAllShape(java.util.Map<java.lang.String,NXshape> shape)` Deprecated. Set multiple child nodes of a particular type.
`void`	`setAllTranslation(java.util.Map<java.lang.String,NXtranslation> translation)` Deprecated. Set multiple child nodes of a particular type.
`DataNode`	`setComponent_index(IDataset component_index)` Deprecated. Position of the component along the beam path.
`DataNode`	`setComponent_indexScalar(java.lang.Long component_index)` Deprecated. Position of the component along the beam path.
`DataNode`	`setDescription(IDataset description)` Deprecated. Optional description/label.
`DataNode`	`setDescriptionScalar(java.lang.String description)` Deprecated. Optional description/label.
`void`	`setOrientation(NXorientation orientation)` Deprecated. orientation of component
`void`	`setOrientation(java.lang.String name, NXorientation orientation)` Deprecated. Set a NXorientation node by name: orientation of component
`void`	`setShape(NXshape shape)` Deprecated. shape/size information of component
`void`	`setShape(java.lang.String name, NXshape shape)` Deprecated. Set a NXshape node by name: shape/size information of component
`void`	`setTranslation(NXtranslation translation)` Deprecated. translation of component
`void`	`setTranslation(java.lang.String name, NXtranslation translation)` Deprecated. Set a NXtranslation node by name: translation of component