• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXbeam_stop.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.NXbeam_stop.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 NXbeam_stop






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


All Known Implementing Classes:
NXbeam_stopImpl




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











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_DISTANCE_TO_DETECTOR 


static java.lang.String
NX_SIZE 


static java.lang.String
NX_STATUS 


static java.lang.String
NX_X 


static java.lang.String
NX_Y 






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


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.
 



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

See Also:
Constant Field Values








NX_SIZE
static final java.lang.String NX_SIZE

See Also:
Constant Field Values








NX_X
static final java.lang.String NX_X

See Also:
Constant Field Values








NX_Y
static final java.lang.String NX_Y

See Also:
Constant Field Values








NX_DISTANCE_TO_DETECTOR
static final java.lang.String NX_DISTANCE_TO_DETECTOR

See Also:
Constant Field Values








NX_STATUS
static final java.lang.String NX_STATUS

See Also:
Constant Field Values










Method Detail





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

Returns:
the value.








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

Parameters:
geometry - the geometry








getGeometry
NXgeometry getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 

 

 engineering shape, orientation and position of the beam stop.
 

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








setGeometry
void setGeometry(java.lang.String name,
                 NXgeometry geometry)
Set a NXgeometry node by name:
 

 

 engineering shape, orientation and position of the beam stop.
 

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








getAllGeometry
java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Get all NXgeometry nodes:
 

 

 engineering shape, orientation and position of the beam stop.
 

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








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

 

 engineering shape, orientation and position of the beam stop.
 

Parameters:
geometry - the child nodes to add








getDescription
IDataset getDescription()
description of beamstop
 

 
Enumeration:

 
circular 
 
rectangular 

 


Returns:
the value.








setDescription
DataNode setDescription(IDataset description)
description of beamstop
 

 
Enumeration:

 
circular 
 
rectangular 

 


Parameters:
description - the description








getDescriptionScalar
java.lang.String getDescriptionScalar()
description of beamstop
 

 
Enumeration:

 
circular 
 
rectangular 

 


Returns:
the value.








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

 
Enumeration:

 
circular 
 
rectangular 

 


Parameters:
description - the description








getSize
IDataset getSize()
size of beamstop
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setSize
DataNode setSize(IDataset size)
size of beamstop
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
size - the size








getSizeScalar
java.lang.Double getSizeScalar()
size of beamstop
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
size - the size








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
x - the x








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
x - the x








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
y - the y








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
y - the y








getDistance_to_detector
IDataset getDistance_to_detector()
distance of the beamstop to the detector
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance_to_detector - the distance_to_detector








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








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

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance_to_detector - the distance_to_detector








getStatus
IDataset getStatus()

 
Enumeration:

 
in 
 
out 

 


Returns:
the value.








setStatus
DataNode setStatus(IDataset status)

 
Enumeration:

 
in 
 
out 

 


Parameters:
status - the status








getStatusScalar
java.lang.String getStatusScalar()

 
Enumeration:

 
in 
 
out 

 


Returns:
the value.








setStatusScalar
DataNode setStatusScalar(java.lang.String status)

 
Enumeration:

 
in 
 
out 

 


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