• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXgeometry.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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 NXgeometry






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


All Known Implementing Classes:
NXgeometryImpl


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



@Deprecated
public interface NXgeometry
extends NXobject
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.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_COMPONENT_INDEX
Deprecated. 
 


static java.lang.String
NX_DESCRIPTION
Deprecated. 
 






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








Method Summary

All Methods Instance Methods Abstract 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.



NXorientation
getOrientation()
Deprecated. 
orientation of component



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



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 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_DESCRIPTION
static final java.lang.String NX_DESCRIPTION
Deprecated. 

See Also:
Constant Field Values








NX_COMPONENT_INDEX
static final java.lang.String NX_COMPONENT_INDEX
Deprecated. 

See Also:
Constant Field Values










Method Detail





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

Returns:
the value.








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

Parameters:
shape - the shape








getShape
NXshape getShape(java.lang.String name)
Deprecated. 
Get a NXshape node by name:
 

 

 shape/size information of component
 

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








setShape
void setShape(java.lang.String name,
              NXshape shape)
Deprecated. 
Set a NXshape node by name:
 

 

 shape/size information of component
 

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








getAllShape
java.util.Map<java.lang.String,NXshape> getAllShape()
Deprecated. 
Get all NXshape nodes:
 

 

 shape/size information of component
 

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








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

 

 shape/size information of component
 

Parameters:
shape - the child nodes to add








getTranslation
NXtranslation getTranslation()
Deprecated. 
translation of component

Returns:
the value.








setTranslation
void setTranslation(NXtranslation translation)
Deprecated. 
translation of component

Parameters:
translation - the translation








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

 

 translation of component
 

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








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

 

 translation of component
 

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








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

 

 translation of component
 

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








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

 

 translation of component
 

Parameters:
translation - the child nodes to add








getOrientation
NXorientation getOrientation()
Deprecated. 
orientation of component

Returns:
the value.








setOrientation
void setOrientation(NXorientation orientation)
Deprecated. 
orientation of component

Parameters:
orientation - the orientation








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

 

 orientation of component
 

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








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

 

 orientation of component
 

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








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

 

 orientation of component
 

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








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

 

 orientation of component
 

Parameters:
orientation - the child nodes to add








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

Returns:
the value.








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

Parameters:
description - the description








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

Returns:
the value.








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

Parameters:
description - the description








getComponent_index
IDataset getComponent_index()
Deprecated. 
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
 

Returns:
the value.








setComponent_index
DataNode setComponent_index(IDataset component_index)
Deprecated. 
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
 

Parameters:
component_index - the component_index








getComponent_indexScalar
java.lang.Long getComponent_indexScalar()
Deprecated. 
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
 

Returns:
the value.








setComponent_indexScalar
DataNode setComponent_indexScalar(java.lang.Long component_index)
Deprecated. 
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
 

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