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






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






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


All Known Implementing Classes:
NXslitImpl




public interface NXslit
extends NXobject
A simple slit.
 For more complex geometries, :ref:`NXaperture` should be used.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DEPENDS_ON 


static java.lang.String
NX_X_GAP 


static java.lang.String
NX_Y_GAP 






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


IDataset
getDepends_on()
Points to the path of the last element in the geometry chain that places
 this object in space.



java.lang.String
getDepends_onScalar()
Points to the path of the last element in the geometry chain that places
 this object in space.



IDataset
getX_gap()
Size of the gap opening in the first dimension of the local
 coordinate system.



java.lang.Number
getX_gapScalar()
Size of the gap opening in the first dimension of the local
 coordinate system.



IDataset
getY_gap()
Size of the gap opening in the second dimension of the local
 coordinate system.



java.lang.Number
getY_gapScalar()
Size of the gap opening in the second dimension of the local
 coordinate system.



DataNode
setDepends_on(IDataset depends_on)
Points to the path of the last element in the geometry chain that places
 this object in space.



DataNode
setDepends_onScalar(java.lang.String depends_on)
Points to the path of the last element in the geometry chain that places
 this object in space.



DataNode
setX_gap(IDataset x_gap)
Size of the gap opening in the first dimension of the local
 coordinate system.



DataNode
setX_gapScalar(java.lang.Number x_gap)
Size of the gap opening in the first dimension of the local
 coordinate system.



DataNode
setY_gap(IDataset y_gap)
Size of the gap opening in the second dimension of the local
 coordinate system.



DataNode
setY_gapScalar(java.lang.Number y_gap)
Size of the gap opening in the second dimension of the local
 coordinate system.







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_DEPENDS_ON
static final java.lang.String NX_DEPENDS_ON

See Also:
Constant Field Values








NX_X_GAP
static final java.lang.String NX_X_GAP

See Also:
Constant Field Values








NX_Y_GAP
static final java.lang.String NX_Y_GAP

See Also:
Constant Field Values










Method Detail





getDepends_on
IDataset getDepends_on()
Points to the path of the last element in the geometry chain that places
 this object in space.
 When followed through that chain is supposed to end at an element depending
 on "." i.e. the origin of the coordinate system.
 If desired the location of the slit can also be described relative to
 an NXbeam, which will allow a simple description of a non-centred slit.
 
 Type: NX_CHAR
 

Returns:
the value.








setDepends_on
DataNode setDepends_on(IDataset depends_on)
Points to the path of the last element in the geometry chain that places
 this object in space.
 When followed through that chain is supposed to end at an element depending
 on "." i.e. the origin of the coordinate system.
 If desired the location of the slit can also be described relative to
 an NXbeam, which will allow a simple description of a non-centred slit.
 
 Type: NX_CHAR
 

Parameters:
depends_on - the depends_on








getDepends_onScalar
java.lang.String getDepends_onScalar()
Points to the path of the last element in the geometry chain that places
 this object in space.
 When followed through that chain is supposed to end at an element depending
 on "." i.e. the origin of the coordinate system.
 If desired the location of the slit can also be described relative to
 an NXbeam, which will allow a simple description of a non-centred slit.
 
 Type: NX_CHAR
 

Returns:
the value.








setDepends_onScalar
DataNode setDepends_onScalar(java.lang.String depends_on)
Points to the path of the last element in the geometry chain that places
 this object in space.
 When followed through that chain is supposed to end at an element depending
 on "." i.e. the origin of the coordinate system.
 If desired the location of the slit can also be described relative to
 an NXbeam, which will allow a simple description of a non-centred slit.
 
 Type: NX_CHAR
 

Parameters:
depends_on - the depends_on








getX_gap
IDataset getX_gap()
Size of the gap opening in the first dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Returns:
the value.








setX_gap
DataNode setX_gap(IDataset x_gap)
Size of the gap opening in the first dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Parameters:
x_gap - the x_gap








getX_gapScalar
java.lang.Number getX_gapScalar()
Size of the gap opening in the first dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Returns:
the value.








setX_gapScalar
DataNode setX_gapScalar(java.lang.Number x_gap)
Size of the gap opening in the first dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Parameters:
x_gap - the x_gap








getY_gap
IDataset getY_gap()
Size of the gap opening in the second dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Returns:
the value.








setY_gap
DataNode setY_gap(IDataset y_gap)
Size of the gap opening in the second dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Parameters:
y_gap - the y_gap








getY_gapScalar
java.lang.Number getY_gapScalar()
Size of the gap opening in the second dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Returns:
the value.








setY_gapScalar
DataNode setY_gapScalar(java.lang.Number y_gap)
Size of the gap opening in the second dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Parameters:
y_gap - the y_gap














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	Field and Description
`static java.lang.String`	`NX_DEPENDS_ON`
`static java.lang.String`	`NX_X_GAP`
`static java.lang.String`	`NX_Y_GAP`

Modifier and Type	Method and Description
`IDataset`	`getDepends_on()` Points to the path of the last element in the geometry chain that places this object in space.
`java.lang.String`	`getDepends_onScalar()` Points to the path of the last element in the geometry chain that places this object in space.
`IDataset`	`getX_gap()` Size of the gap opening in the first dimension of the local coordinate system.
`java.lang.Number`	`getX_gapScalar()` Size of the gap opening in the first dimension of the local coordinate system.
`IDataset`	`getY_gap()` Size of the gap opening in the second dimension of the local coordinate system.
`java.lang.Number`	`getY_gapScalar()` Size of the gap opening in the second dimension of the local coordinate system.
`DataNode`	`setDepends_on(IDataset depends_on)` Points to the path of the last element in the geometry chain that places this object in space.
`DataNode`	`setDepends_onScalar(java.lang.String depends_on)` Points to the path of the last element in the geometry chain that places this object in space.
`DataNode`	`setX_gap(IDataset x_gap)` Size of the gap opening in the first dimension of the local coordinate system.
`DataNode`	`setX_gapScalar(java.lang.Number x_gap)` Size of the gap opening in the first dimension of the local coordinate system.
`DataNode`	`setY_gap(IDataset y_gap)` Size of the gap opening in the second dimension of the local coordinate system.
`DataNode`	`setY_gapScalar(java.lang.Number y_gap)` Size of the gap opening in the second dimension of the local coordinate system.