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






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



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













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




public class NXslitImpl
extends NXobjectImpl
implements NXslit
A simple slit.
 For more complex geometries, :ref:`NXaperture` should be used.

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.NXslit
NX_DEPENDS_ON, NX_X_GAP, NX_Y_GAP





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








Constructor Summary

Constructors 

Constructor and Description


NXslitImpl() 


NXslitImpl(long oid) 









Method Summary

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



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





NXslitImpl
public NXslitImpl()







NXslitImpl
public NXslitImpl(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








getDepends_on
public IDataset getDepends_on()
Description copied from interface: NXslit
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
 

Specified by:
getDepends_on in interface NXslit
Returns:
the value.








getDepends_onScalar
public java.lang.String getDepends_onScalar()
Description copied from interface: NXslit
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
 

Specified by:
getDepends_onScalar in interface NXslit
Returns:
the value.








setDepends_on
public DataNode setDepends_on(IDataset depends_on)
Description copied from interface: NXslit
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
 

Specified by:
setDepends_on in interface NXslit
Parameters:
depends_on - the depends_on








setDepends_onScalar
public DataNode setDepends_onScalar(java.lang.String depends_on)
Description copied from interface: NXslit
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
 

Specified by:
setDepends_onScalar in interface NXslit
Parameters:
depends_on - the depends_on








getX_gap
public IDataset getX_gap()
Description copied from interface: NXslit
Size of the gap opening in the first dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Specified by:
getX_gap in interface NXslit
Returns:
the value.








getX_gapScalar
public java.lang.Number getX_gapScalar()
Description copied from interface: NXslit
Size of the gap opening in the first dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Specified by:
getX_gapScalar in interface NXslit
Returns:
the value.








setX_gap
public DataNode setX_gap(IDataset x_gap)
Description copied from interface: NXslit
Size of the gap opening in the first dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Specified by:
setX_gap in interface NXslit
Parameters:
x_gap - the x_gap








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

Specified by:
setX_gapScalar in interface NXslit
Parameters:
x_gap - the x_gap








getY_gap
public IDataset getY_gap()
Description copied from interface: NXslit
Size of the gap opening in the second dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Specified by:
getY_gap in interface NXslit
Returns:
the value.








getY_gapScalar
public java.lang.Number getY_gapScalar()
Description copied from interface: NXslit
Size of the gap opening in the second dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Specified by:
getY_gapScalar in interface NXslit
Returns:
the value.








setY_gap
public DataNode setY_gap(IDataset y_gap)
Description copied from interface: NXslit
Size of the gap opening in the second dimension of the local
 coordinate system.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Specified by:
setY_gap in interface NXslit
Parameters:
y_gap - the y_gap








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

Specified by:
setY_gapScalar in interface NXslit
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	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.
`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`	`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.

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