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






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



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













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




public class NXbeam_stopImpl
extends NXobjectImpl
implements NXbeam_stop
A device that blocks the beam completely, usually to protect a detector.
 Beamstops and their positions are important for SANS
 and SAXS experiments.

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.NXbeam_stop
NX_DESCRIPTION, NX_DISTANCE_TO_DETECTOR, NX_SIZE, NX_STATUS, NX_X, NX_Y





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








Constructor Summary

Constructors 

Constructor and Description


NXbeam_stopImpl() 


NXbeam_stopImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
 
 
 engineering shape, orientation and position of the beam stop.
 



IDataset
getDescription()
description of beamstop



java.lang.String
getDescriptionScalar()
description of beamstop



IDataset
getDistance_to_detector()
distance of the beamstop to the detector



java.lang.Double
getDistance_to_detectorScalar()
distance of the beamstop to the detector



NXgeometry
getGeometry()
engineering shape, orientation and position of the beam stop.



NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 engineering shape, orientation and position of the beam stop.
 



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
getSize()
size of beamstop



java.lang.Double
getSizeScalar()
size of beamstop



IDataset
getStatus()


java.lang.String
getStatusScalar()


IDataset
getX()
x position of the beamstop in relation to the detector



java.lang.Double
getXScalar()
x position of the beamstop in relation to the detector



IDataset
getY()
y position of the beamstop in relation to the detector



java.lang.Double
getYScalar()
y position of the beamstop in relation to the detector



void
setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Set multiple child nodes of a particular type.



DataNode
setDescription(IDataset description)
description of beamstop



DataNode
setDescriptionScalar(java.lang.String description)
description of beamstop



DataNode
setDistance_to_detector(IDataset distance_to_detector)
distance of the beamstop to the detector



DataNode
setDistance_to_detectorScalar(java.lang.Double distance_to_detector)
distance of the beamstop to the detector



void
setGeometry(NXgeometry geometry)
engineering shape, orientation and position of the beam stop.



void
setGeometry(java.lang.String name,
           NXgeometry geometry)
Set a NXgeometry node by name:
 
 
 engineering shape, orientation and position of the beam stop.
 



DataNode
setSize(IDataset size)
size of beamstop



DataNode
setSizeScalar(java.lang.Double size)
size of beamstop



DataNode
setStatus(IDataset status)


DataNode
setStatusScalar(java.lang.String status)


DataNode
setX(IDataset x)
x position of the beamstop in relation to the detector



DataNode
setXScalar(java.lang.Double x)
x position of the beamstop in relation to the detector



DataNode
setY(IDataset y)
y position of the beamstop in relation to the detector



DataNode
setYScalar(java.lang.Double y)
y position of the beamstop in relation to the detector







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





NXbeam_stopImpl
public NXbeam_stopImpl()







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








getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXbeam_stop
engineering shape, orientation and position of the beam stop.

Specified by:
getGeometry in interface NXbeam_stop
Returns:
the value.








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXbeam_stop
engineering shape, orientation and position of the beam stop.

Specified by:
setGeometry in interface NXbeam_stop
Parameters:
geometry - the geometry








getGeometry
public NXgeometry getGeometry(java.lang.String name)
Description copied from interface: NXbeam_stop
Get a NXgeometry node by name:
 
 
 engineering shape, orientation and position of the beam stop.
 

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








setGeometry
public void setGeometry(java.lang.String name,
                        NXgeometry geometry)
Description copied from interface: NXbeam_stop
Set a NXgeometry node by name:
 
 
 engineering shape, orientation and position of the beam stop.
 

Specified by:
setGeometry in interface NXbeam_stop
Parameters:
name - the name of the node
geometry - the value to set








getAllGeometry
public java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Description copied from interface: NXbeam_stop
Get all NXgeometry nodes:
 
 
 engineering shape, orientation and position of the beam stop.
 

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








setAllGeometry
public void setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)
Description copied from interface: NXbeam_stop
Set multiple child nodes of a particular type.
 
 
 engineering shape, orientation and position of the beam stop.
 

Specified by:
setAllGeometry in interface NXbeam_stop
Parameters:
geometry - the child nodes to add








getDescription
public IDataset getDescription()
Description copied from interface: NXbeam_stop
description of beamstop
 
 
Enumeration:

 circular 
 rectangular 

 

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








getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXbeam_stop
description of beamstop
 
 
Enumeration:

 circular 
 rectangular 

 

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








setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXbeam_stop
description of beamstop
 
 
Enumeration:

 circular 
 rectangular 

 

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








setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXbeam_stop
description of beamstop
 
 
Enumeration:

 circular 
 rectangular 

 

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








getSize
public IDataset getSize()
Description copied from interface: NXbeam_stop
size of beamstop
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSize in interface NXbeam_stop
Returns:
the value.








getSizeScalar
public java.lang.Double getSizeScalar()
Description copied from interface: NXbeam_stop
size of beamstop
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSizeScalar in interface NXbeam_stop
Returns:
the value.








setSize
public DataNode setSize(IDataset size)
Description copied from interface: NXbeam_stop
size of beamstop
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSize in interface NXbeam_stop
Parameters:
size - the size








setSizeScalar
public DataNode setSizeScalar(java.lang.Double size)
Description copied from interface: NXbeam_stop
size of beamstop
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSizeScalar in interface NXbeam_stop
Parameters:
size - the size








getX
public IDataset getX()
Description copied from interface: NXbeam_stop
x position of the beamstop in relation to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getX in interface NXbeam_stop
Returns:
the value.








getXScalar
public java.lang.Double getXScalar()
Description copied from interface: NXbeam_stop
x position of the beamstop in relation to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getXScalar in interface NXbeam_stop
Returns:
the value.








setX
public DataNode setX(IDataset x)
Description copied from interface: NXbeam_stop
x position of the beamstop in relation to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setX in interface NXbeam_stop
Parameters:
x - the x








setXScalar
public DataNode setXScalar(java.lang.Double x)
Description copied from interface: NXbeam_stop
x position of the beamstop in relation to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setXScalar in interface NXbeam_stop
Parameters:
x - the x








getY
public IDataset getY()
Description copied from interface: NXbeam_stop
y position of the beamstop in relation to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getY in interface NXbeam_stop
Returns:
the value.








getYScalar
public java.lang.Double getYScalar()
Description copied from interface: NXbeam_stop
y position of the beamstop in relation to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getYScalar in interface NXbeam_stop
Returns:
the value.








setY
public DataNode setY(IDataset y)
Description copied from interface: NXbeam_stop
y position of the beamstop in relation to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setY in interface NXbeam_stop
Parameters:
y - the y








setYScalar
public DataNode setYScalar(java.lang.Double y)
Description copied from interface: NXbeam_stop
y position of the beamstop in relation to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setYScalar in interface NXbeam_stop
Parameters:
y - the y








getDistance_to_detector
public IDataset getDistance_to_detector()
Description copied from interface: NXbeam_stop
distance of the beamstop to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDistance_to_detector in interface NXbeam_stop
Returns:
the value.








getDistance_to_detectorScalar
public java.lang.Double getDistance_to_detectorScalar()
Description copied from interface: NXbeam_stop
distance of the beamstop to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDistance_to_detectorScalar in interface NXbeam_stop
Returns:
the value.








setDistance_to_detector
public DataNode setDistance_to_detector(IDataset distance_to_detector)
Description copied from interface: NXbeam_stop
distance of the beamstop to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDistance_to_detector in interface NXbeam_stop
Parameters:
distance_to_detector - the distance_to_detector








setDistance_to_detectorScalar
public DataNode setDistance_to_detectorScalar(java.lang.Double distance_to_detector)
Description copied from interface: NXbeam_stop
distance of the beamstop to the detector
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDistance_to_detectorScalar in interface NXbeam_stop
Parameters:
distance_to_detector - the distance_to_detector








getStatus
public IDataset getStatus()
Description copied from interface: NXbeam_stop

 
Enumeration:

 in 
 out 

 

Specified by:
getStatus in interface NXbeam_stop
Returns:
the value.








getStatusScalar
public java.lang.String getStatusScalar()
Description copied from interface: NXbeam_stop

 
Enumeration:

 in 
 out 

 

Specified by:
getStatusScalar in interface NXbeam_stop
Returns:
the value.








setStatus
public DataNode setStatus(IDataset status)
Description copied from interface: NXbeam_stop

 
Enumeration:

 in 
 out 

 

Specified by:
setStatus in interface NXbeam_stop
Parameters:
status - the status








setStatusScalar
public DataNode setStatusScalar(java.lang.String status)
Description copied from interface: NXbeam_stop

 
Enumeration:

 in 
 out 

 

Specified by:
setStatusScalar in interface NXbeam_stop
Parameters:
status - the status














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,NXgeometry>`	`getAllGeometry()` Get all NXgeometry nodes: engineering shape, orientation and position of the beam stop.
`IDataset`	`getDescription()` description of beamstop
`java.lang.String`	`getDescriptionScalar()` description of beamstop
`IDataset`	`getDistance_to_detector()` distance of the beamstop to the detector
`java.lang.Double`	`getDistance_to_detectorScalar()` distance of the beamstop to the detector
`NXgeometry`	`getGeometry()` engineering shape, orientation and position of the beam stop.
`NXgeometry`	`getGeometry(java.lang.String name)` Get a NXgeometry node by name: engineering shape, orientation and position of the beam stop.
`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`	`getSize()` size of beamstop
`java.lang.Double`	`getSizeScalar()` size of beamstop
`IDataset`	`getStatus()`
`java.lang.String`	`getStatusScalar()`
`IDataset`	`getX()` x position of the beamstop in relation to the detector
`java.lang.Double`	`getXScalar()` x position of the beamstop in relation to the detector
`IDataset`	`getY()` y position of the beamstop in relation to the detector
`java.lang.Double`	`getYScalar()` y position of the beamstop in relation to the detector
`void`	`setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)` Set multiple child nodes of a particular type.
`DataNode`	`setDescription(IDataset description)` description of beamstop
`DataNode`	`setDescriptionScalar(java.lang.String description)` description of beamstop
`DataNode`	`setDistance_to_detector(IDataset distance_to_detector)` distance of the beamstop to the detector
`DataNode`	`setDistance_to_detectorScalar(java.lang.Double distance_to_detector)` distance of the beamstop to the detector
`void`	`setGeometry(NXgeometry geometry)` engineering shape, orientation and position of the beam stop.
`void`	`setGeometry(java.lang.String name, NXgeometry geometry)` Set a NXgeometry node by name: engineering shape, orientation and position of the beam stop.
`DataNode`	`setSize(IDataset size)` size of beamstop
`DataNode`	`setSizeScalar(java.lang.Double size)` size of beamstop
`DataNode`	`setStatus(IDataset status)`
`DataNode`	`setStatusScalar(java.lang.String status)`
`DataNode`	`setX(IDataset x)` x position of the beamstop in relation to the detector
`DataNode`	`setXScalar(java.lang.Double x)` x position of the beamstop in relation to the detector
`DataNode`	`setY(IDataset y)` y position of the beamstop in relation to the detector
`DataNode`	`setYScalar(java.lang.Double y)` y position of the beamstop in relation to the detector

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