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






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



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













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




public class NXpinholeImpl
extends NXobjectImpl
implements NXpinhole
A simple pinhole.
 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.NXpinhole
NX_DEPENDS_ON, NX_DIAMETER





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








Constructor Summary

Constructors 

Constructor and Description


NXpinholeImpl() 


NXpinholeImpl(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.



IDataset
getDiameter()
Size of the circular hole defining the transmitted beam size.



java.lang.Number
getDiameterScalar()
Size of the circular hole defining the transmitted beam size.



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.



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
setDiameter(IDataset diameter)
Size of the circular hole defining the transmitted beam size.



DataNode
setDiameterScalar(java.lang.Number diameter)
Size of the circular hole defining the transmitted beam size.







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





NXpinholeImpl
public NXpinholeImpl()







NXpinholeImpl
public NXpinholeImpl(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: NXpinhole
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 pinhole.
 
 Type: NX_CHAR
 

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








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

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








setDepends_on
public DataNode setDepends_on(IDataset depends_on)
Description copied from interface: NXpinhole
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 pinhole.
 
 Type: NX_CHAR
 

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








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

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








getDiameter
public IDataset getDiameter()
Description copied from interface: NXpinhole
Size of the circular hole defining the transmitted beam size.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Specified by:
getDiameter in interface NXpinhole
Returns:
the value.








getDiameterScalar
public java.lang.Number getDiameterScalar()
Description copied from interface: NXpinhole
Size of the circular hole defining the transmitted beam size.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Specified by:
getDiameterScalar in interface NXpinhole
Returns:
the value.








setDiameter
public DataNode setDiameter(IDataset diameter)
Description copied from interface: NXpinhole
Size of the circular hole defining the transmitted beam size.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Specified by:
setDiameter in interface NXpinhole
Parameters:
diameter - the diameter








setDiameterScalar
public DataNode setDiameterScalar(java.lang.Number diameter)
Description copied from interface: NXpinhole
Size of the circular hole defining the transmitted beam size.
 
 Type: NX_NUMBER
 Units: NX_LENGTH
 

Specified by:
setDiameterScalar in interface NXpinhole
Parameters:
diameter - the diameter














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.
`IDataset`	`getDiameter()` Size of the circular hole defining the transmitted beam size.
`java.lang.Number`	`getDiameterScalar()` Size of the circular hole defining the transmitted beam size.
`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.
`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`	`setDiameter(IDataset diameter)` Size of the circular hole defining the transmitted beam size.
`DataNode`	`setDiameterScalar(java.lang.Number diameter)` Size of the circular hole defining the transmitted beam size.

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