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






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


All Known Implementing Classes:
NXfermi_chopperImpl




public interface NXfermi_chopper
extends NXobject
A Fermi chopper, possibly with curved slits.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_ABSORBING_MATERIAL 


static java.lang.String
NX_DISTANCE 


static java.lang.String
NX_ENERGY 


static java.lang.String
NX_HEIGHT 


static java.lang.String
NX_NUMBER 


static java.lang.String
NX_R_SLIT 


static java.lang.String
NX_RADIUS 


static java.lang.String
NX_ROTATION_SPEED 


static java.lang.String
NX_SLIT 


static java.lang.String
NX_TRANSMITTING_MATERIAL 


static java.lang.String
NX_TYPE 


static java.lang.String
NX_WAVELENGTH 


static java.lang.String
NX_WIDTH 






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
getAbsorbing_material()
absorbing material



java.lang.String
getAbsorbing_materialScalar()
absorbing material



java.util.Map<java.lang.String,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
 
 
 geometry of the fermi chopper
 



IDataset
getDistance()
distance



java.lang.Double
getDistanceScalar()
distance



IDataset
getEnergy()
energy selected



java.lang.Double
getEnergyScalar()
energy selected



NXgeometry
getGeometry()
geometry of the fermi chopper



NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 geometry of the fermi chopper
 



IDataset
getHeight()
input beam height



java.lang.Double
getHeightScalar()
input beam height



IDataset
getNumber()
number of slits



java.lang.Long
getNumberScalar()
number of slits



IDataset
getR_slit()
radius of curvature of slits



java.lang.Double
getR_slitScalar()
radius of curvature of slits



IDataset
getRadius()
radius of chopper



java.lang.Double
getRadiusScalar()
radius of chopper



IDataset
getRotation_speed()
chopper rotation speed



java.lang.Double
getRotation_speedScalar()
chopper rotation speed



IDataset
getSlit()
width of an individual slit



java.lang.Double
getSlitScalar()
width of an individual slit



IDataset
getTransmitting_material()
transmitting material



java.lang.String
getTransmitting_materialScalar()
transmitting material



IDataset
getType()
Fermi chopper type



java.lang.String
getTypeScalar()
Fermi chopper type



IDataset
getWavelength()
Wavelength transmitted by chopper



java.lang.Double
getWavelengthScalar()
Wavelength transmitted by chopper



IDataset
getWidth()
input beam width



java.lang.Double
getWidthScalar()
input beam width



DataNode
setAbsorbing_material(IDataset absorbing_material)
absorbing material



DataNode
setAbsorbing_materialScalar(java.lang.String absorbing_material)
absorbing material



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



DataNode
setDistance(IDataset distance)
distance



DataNode
setDistanceScalar(java.lang.Double distance)
distance



DataNode
setEnergy(IDataset energy)
energy selected



DataNode
setEnergyScalar(java.lang.Double energy)
energy selected



void
setGeometry(NXgeometry geometry)
geometry of the fermi chopper



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



DataNode
setHeight(IDataset height)
input beam height



DataNode
setHeightScalar(java.lang.Double height)
input beam height



DataNode
setNumber(IDataset number)
number of slits



DataNode
setNumberScalar(java.lang.Long number)
number of slits



DataNode
setR_slit(IDataset r_slit)
radius of curvature of slits



DataNode
setR_slitScalar(java.lang.Double r_slit)
radius of curvature of slits



DataNode
setRadius(IDataset radius)
radius of chopper



DataNode
setRadiusScalar(java.lang.Double radius)
radius of chopper



DataNode
setRotation_speed(IDataset rotation_speed)
chopper rotation speed



DataNode
setRotation_speedScalar(java.lang.Double rotation_speed)
chopper rotation speed



DataNode
setSlit(IDataset slit)
width of an individual slit



DataNode
setSlitScalar(java.lang.Double slit)
width of an individual slit



DataNode
setTransmitting_material(IDataset transmitting_material)
transmitting material



DataNode
setTransmitting_materialScalar(java.lang.String transmitting_material)
transmitting material



DataNode
setType(IDataset type)
Fermi chopper type



DataNode
setTypeScalar(java.lang.String type)
Fermi chopper type



DataNode
setWavelength(IDataset wavelength)
Wavelength transmitted by chopper



DataNode
setWavelengthScalar(java.lang.Double wavelength)
Wavelength transmitted by chopper



DataNode
setWidth(IDataset width)
input beam width



DataNode
setWidthScalar(java.lang.Double width)
input beam width







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_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_ROTATION_SPEED
static final java.lang.String NX_ROTATION_SPEED

See Also:
Constant Field Values








NX_RADIUS
static final java.lang.String NX_RADIUS

See Also:
Constant Field Values








NX_SLIT
static final java.lang.String NX_SLIT

See Also:
Constant Field Values








NX_R_SLIT
static final java.lang.String NX_R_SLIT

See Also:
Constant Field Values








NX_NUMBER
static final java.lang.String NX_NUMBER

See Also:
Constant Field Values








NX_HEIGHT
static final java.lang.String NX_HEIGHT

See Also:
Constant Field Values








NX_WIDTH
static final java.lang.String NX_WIDTH

See Also:
Constant Field Values








NX_DISTANCE
static final java.lang.String NX_DISTANCE

See Also:
Constant Field Values








NX_WAVELENGTH
static final java.lang.String NX_WAVELENGTH

See Also:
Constant Field Values








NX_ENERGY
static final java.lang.String NX_ENERGY

See Also:
Constant Field Values








NX_ABSORBING_MATERIAL
static final java.lang.String NX_ABSORBING_MATERIAL

See Also:
Constant Field Values








NX_TRANSMITTING_MATERIAL
static final java.lang.String NX_TRANSMITTING_MATERIAL

See Also:
Constant Field Values










Method Detail





getType
IDataset getType()
Fermi chopper type

Returns:
the value.








setType
DataNode setType(IDataset type)
Fermi chopper type

Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()
Fermi chopper type

Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)
Fermi chopper type

Parameters:
type - the type








getRotation_speed
IDataset getRotation_speed()
chopper rotation speed
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Returns:
the value.








setRotation_speed
DataNode setRotation_speed(IDataset rotation_speed)
chopper rotation speed
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Parameters:
rotation_speed - the rotation_speed








getRotation_speedScalar
java.lang.Double getRotation_speedScalar()
chopper rotation speed
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Returns:
the value.








setRotation_speedScalar
DataNode setRotation_speedScalar(java.lang.Double rotation_speed)
chopper rotation speed
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Parameters:
rotation_speed - the rotation_speed








getRadius
IDataset getRadius()
radius of chopper
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setRadius
DataNode setRadius(IDataset radius)
radius of chopper
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
radius - the radius








getRadiusScalar
java.lang.Double getRadiusScalar()
radius of chopper
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setRadiusScalar
DataNode setRadiusScalar(java.lang.Double radius)
radius of chopper
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
radius - the radius








getSlit
IDataset getSlit()
width of an individual slit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setSlit
DataNode setSlit(IDataset slit)
width of an individual slit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
slit - the slit








getSlitScalar
java.lang.Double getSlitScalar()
width of an individual slit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setSlitScalar
DataNode setSlitScalar(java.lang.Double slit)
width of an individual slit
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
slit - the slit








getR_slit
IDataset getR_slit()
radius of curvature of slits
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setR_slit
DataNode setR_slit(IDataset r_slit)
radius of curvature of slits
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
r_slit - the r_slit








getR_slitScalar
java.lang.Double getR_slitScalar()
radius of curvature of slits
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setR_slitScalar
DataNode setR_slitScalar(java.lang.Double r_slit)
radius of curvature of slits
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
r_slit - the r_slit








getNumber
IDataset getNumber()
number of slits
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Returns:
the value.








setNumber
DataNode setNumber(IDataset number)
number of slits
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Parameters:
number - the number








getNumberScalar
java.lang.Long getNumberScalar()
number of slits
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Returns:
the value.








setNumberScalar
DataNode setNumberScalar(java.lang.Long number)
number of slits
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Parameters:
number - the number








getHeight
IDataset getHeight()
input beam height
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setHeight
DataNode setHeight(IDataset height)
input beam height
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
height - the height








getHeightScalar
java.lang.Double getHeightScalar()
input beam height
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setHeightScalar
DataNode setHeightScalar(java.lang.Double height)
input beam height
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
height - the height








getWidth
IDataset getWidth()
input beam width
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setWidth
DataNode setWidth(IDataset width)
input beam width
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
width - the width








getWidthScalar
java.lang.Double getWidthScalar()
input beam width
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setWidthScalar
DataNode setWidthScalar(java.lang.Double width)
input beam width
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
width - the width








getDistance
IDataset getDistance()
distance
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistance
DataNode setDistance(IDataset distance)
distance
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getDistanceScalar
java.lang.Double getDistanceScalar()
distance
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistanceScalar
DataNode setDistanceScalar(java.lang.Double distance)
distance
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getWavelength
IDataset getWavelength()
Wavelength transmitted by chopper
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Returns:
the value.








setWavelength
DataNode setWavelength(IDataset wavelength)
Wavelength transmitted by chopper
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Parameters:
wavelength - the wavelength








getWavelengthScalar
java.lang.Double getWavelengthScalar()
Wavelength transmitted by chopper
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Returns:
the value.








setWavelengthScalar
DataNode setWavelengthScalar(java.lang.Double wavelength)
Wavelength transmitted by chopper
 

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Parameters:
wavelength - the wavelength








getEnergy
IDataset getEnergy()
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setEnergy
DataNode setEnergy(IDataset energy)
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
energy - the energy








getEnergyScalar
java.lang.Double getEnergyScalar()
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setEnergyScalar
DataNode setEnergyScalar(java.lang.Double energy)
energy selected
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
energy - the energy








getGeometry
NXgeometry getGeometry()
geometry of the fermi chopper

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)
geometry of the fermi chopper

Parameters:
geometry - the geometry








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

 

 geometry of the fermi chopper
 

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:
 

 

 geometry of the fermi chopper
 

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:
 

 

 geometry of the fermi chopper
 

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.
 

 

 geometry of the fermi chopper
 

Parameters:
geometry - the child nodes to add








getAbsorbing_material
IDataset getAbsorbing_material()
absorbing material

Returns:
the value.








setAbsorbing_material
DataNode setAbsorbing_material(IDataset absorbing_material)
absorbing material

Parameters:
absorbing_material - the absorbing_material








getAbsorbing_materialScalar
java.lang.String getAbsorbing_materialScalar()
absorbing material

Returns:
the value.








setAbsorbing_materialScalar
DataNode setAbsorbing_materialScalar(java.lang.String absorbing_material)
absorbing material

Parameters:
absorbing_material - the absorbing_material








getTransmitting_material
IDataset getTransmitting_material()
transmitting material

Returns:
the value.








setTransmitting_material
DataNode setTransmitting_material(IDataset transmitting_material)
transmitting material

Parameters:
transmitting_material - the transmitting_material








getTransmitting_materialScalar
java.lang.String getTransmitting_materialScalar()
transmitting material

Returns:
the value.








setTransmitting_materialScalar
DataNode setTransmitting_materialScalar(java.lang.String transmitting_material)
transmitting material

Parameters:
transmitting_material - the transmitting_material














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