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






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


All Known Implementing Classes:
NXinsertion_deviceImpl




public interface NXinsertion_device
extends NXobject
An insertion device, as used in a synchrotron light source.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_BANDWIDTH 


static java.lang.String
NX_ENERGY 


static java.lang.String
NX_GAP 


static java.lang.String
NX_HARMONIC 


static java.lang.String
NX_K 


static java.lang.String
NX_LENGTH 


static java.lang.String
NX_MAGNETIC_WAVELENGTH 


static java.lang.String
NX_PHASE 


static java.lang.String
NX_POLES 


static java.lang.String
NX_POWER 


static java.lang.String
NX_TAPER 


static java.lang.String
NX_TYPE 






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" position of insertion device
 



IDataset
getBandwidth()
bandwidth of peak energy



java.lang.Double
getBandwidthScalar()
bandwidth of peak energy



IDataset
getEnergy()
energy of peak intensity in output spectrum



java.lang.Double
getEnergyScalar()
energy of peak intensity in output spectrum



IDataset
getGap()
separation between opposing pairs of magnetic poles



java.lang.Double
getGapScalar()
separation between opposing pairs of magnetic poles



NXgeometry
getGeometry()
"Engineering" position of insertion device



NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 "Engineering" position of insertion device
 



IDataset
getHarmonic()
harmonic number of peak



java.lang.Long
getHarmonicScalar()
harmonic number of peak



IDataset
getK()
beam displacement parameter



java.lang.Double
getKScalar()
beam displacement parameter



IDataset
getLength()
length of insertion device



java.lang.Double
getLengthScalar()
length of insertion device



IDataset
getMagnetic_wavelength()

 Type: NX_FLOAT
 Units: NX_WAVELENGTH



java.lang.Double
getMagnetic_wavelengthScalar()

 Type: NX_FLOAT
 Units: NX_WAVELENGTH



IDataset
getPhase()

 Type: NX_FLOAT
 Units: NX_ANGLE



java.lang.Double
getPhaseScalar()

 Type: NX_FLOAT
 Units: NX_ANGLE



IDataset
getPoles()
number of poles



java.lang.Long
getPolesScalar()
number of poles



IDataset
getPower()
total power delivered by insertion device



java.lang.Double
getPowerScalar()
total power delivered by insertion device



NXdata
getSpectrum()
spectrum of insertion device



IDataset
getTaper()
angular of gap difference between upstream and downstream ends of the insertion device



java.lang.Double
getTaperScalar()
angular of gap difference between upstream and downstream ends of the insertion device



IDataset
getType()


java.lang.String
getTypeScalar()


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



DataNode
setBandwidth(IDataset bandwidth)
bandwidth of peak energy



DataNode
setBandwidthScalar(java.lang.Double bandwidth)
bandwidth of peak energy



DataNode
setEnergy(IDataset energy)
energy of peak intensity in output spectrum



DataNode
setEnergyScalar(java.lang.Double energy)
energy of peak intensity in output spectrum



DataNode
setGap(IDataset gap)
separation between opposing pairs of magnetic poles



DataNode
setGapScalar(java.lang.Double gap)
separation between opposing pairs of magnetic poles



void
setGeometry(NXgeometry geometry)
"Engineering" position of insertion device



void
setGeometry(java.lang.String name,
           NXgeometry geometry)
Set a NXgeometry node by name:
 
 
 "Engineering" position of insertion device
 



DataNode
setHarmonic(IDataset harmonic)
harmonic number of peak



DataNode
setHarmonicScalar(java.lang.Long harmonic)
harmonic number of peak



DataNode
setK(IDataset k)
beam displacement parameter



DataNode
setKScalar(java.lang.Double k)
beam displacement parameter



DataNode
setLength(IDataset length)
length of insertion device



DataNode
setLengthScalar(java.lang.Double length)
length of insertion device



DataNode
setMagnetic_wavelength(IDataset magnetic_wavelength)

 Type: NX_FLOAT
 Units: NX_WAVELENGTH



DataNode
setMagnetic_wavelengthScalar(java.lang.Double magnetic_wavelength)

 Type: NX_FLOAT
 Units: NX_WAVELENGTH



DataNode
setPhase(IDataset phase)

 Type: NX_FLOAT
 Units: NX_ANGLE



DataNode
setPhaseScalar(java.lang.Double phase)

 Type: NX_FLOAT
 Units: NX_ANGLE



DataNode
setPoles(IDataset poles)
number of poles



DataNode
setPolesScalar(java.lang.Long poles)
number of poles



DataNode
setPower(IDataset power)
total power delivered by insertion device



DataNode
setPowerScalar(java.lang.Double power)
total power delivered by insertion device



void
setSpectrum(NXdata spectrum)
spectrum of insertion device



DataNode
setTaper(IDataset taper)
angular of gap difference between upstream and downstream ends of the insertion device



DataNode
setTaperScalar(java.lang.Double taper)
angular of gap difference between upstream and downstream ends of the insertion device



DataNode
setType(IDataset type)


DataNode
setTypeScalar(java.lang.String type)






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_GAP
static final java.lang.String NX_GAP

See Also:
Constant Field Values








NX_TAPER
static final java.lang.String NX_TAPER

See Also:
Constant Field Values








NX_PHASE
static final java.lang.String NX_PHASE

See Also:
Constant Field Values








NX_POLES
static final java.lang.String NX_POLES

See Also:
Constant Field Values








NX_MAGNETIC_WAVELENGTH
static final java.lang.String NX_MAGNETIC_WAVELENGTH

See Also:
Constant Field Values








NX_K
static final java.lang.String NX_K

See Also:
Constant Field Values








NX_LENGTH
static final java.lang.String NX_LENGTH

See Also:
Constant Field Values








NX_POWER
static final java.lang.String NX_POWER

See Also:
Constant Field Values








NX_ENERGY
static final java.lang.String NX_ENERGY

See Also:
Constant Field Values








NX_BANDWIDTH
static final java.lang.String NX_BANDWIDTH

See Also:
Constant Field Values








NX_HARMONIC
static final java.lang.String NX_HARMONIC

See Also:
Constant Field Values










Method Detail





getType
IDataset getType()

 
Enumeration:

 
undulator 
 
wiggler 

 


Returns:
the value.








setType
DataNode setType(IDataset type)

 
Enumeration:

 
undulator 
 
wiggler 

 


Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()

 
Enumeration:

 
undulator 
 
wiggler 

 


Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)

 
Enumeration:

 
undulator 
 
wiggler 

 


Parameters:
type - the type








getGap
IDataset getGap()
separation between opposing pairs of magnetic poles
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setGap
DataNode setGap(IDataset gap)
separation between opposing pairs of magnetic poles
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
gap - the gap








getGapScalar
java.lang.Double getGapScalar()
separation between opposing pairs of magnetic poles
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setGapScalar
DataNode setGapScalar(java.lang.Double gap)
separation between opposing pairs of magnetic poles
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
gap - the gap








getTaper
IDataset getTaper()
angular of gap difference between upstream and downstream ends of the insertion device
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setTaper
DataNode setTaper(IDataset taper)
angular of gap difference between upstream and downstream ends of the insertion device
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
taper - the taper








getTaperScalar
java.lang.Double getTaperScalar()
angular of gap difference between upstream and downstream ends of the insertion device
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setTaperScalar
DataNode setTaperScalar(java.lang.Double taper)
angular of gap difference between upstream and downstream ends of the insertion device
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
taper - the taper








getPhase
IDataset getPhase()

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setPhase
DataNode setPhase(IDataset phase)

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
phase - the phase








getPhaseScalar
java.lang.Double getPhaseScalar()

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setPhaseScalar
DataNode setPhaseScalar(java.lang.Double phase)

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
phase - the phase








getPoles
IDataset getPoles()
number of poles
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Returns:
the value.








setPoles
DataNode setPoles(IDataset poles)
number of poles
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Parameters:
poles - the poles








getPolesScalar
java.lang.Long getPolesScalar()
number of poles
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Returns:
the value.








setPolesScalar
DataNode setPolesScalar(java.lang.Long poles)
number of poles
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Parameters:
poles - the poles








getMagnetic_wavelength
IDataset getMagnetic_wavelength()

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Returns:
the value.








setMagnetic_wavelength
DataNode setMagnetic_wavelength(IDataset magnetic_wavelength)

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Parameters:
magnetic_wavelength - the magnetic_wavelength








getMagnetic_wavelengthScalar
java.lang.Double getMagnetic_wavelengthScalar()

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Returns:
the value.








setMagnetic_wavelengthScalar
DataNode setMagnetic_wavelengthScalar(java.lang.Double magnetic_wavelength)

 Type: NX_FLOAT
 Units: NX_WAVELENGTH
 

Parameters:
magnetic_wavelength - the magnetic_wavelength








getK
IDataset getK()
beam displacement parameter
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Returns:
the value.








setK
DataNode setK(IDataset k)
beam displacement parameter
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Parameters:
k - the k








getKScalar
java.lang.Double getKScalar()
beam displacement parameter
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Returns:
the value.








setKScalar
DataNode setKScalar(java.lang.Double k)
beam displacement parameter
 

 Type: NX_FLOAT
 Units: NX_DIMENSIONLESS
 

Parameters:
k - the k








getLength
IDataset getLength()
length of insertion device
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setLength
DataNode setLength(IDataset length)
length of insertion device
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
length - the length








getLengthScalar
java.lang.Double getLengthScalar()
length of insertion device
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setLengthScalar
DataNode setLengthScalar(java.lang.Double length)
length of insertion device
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
length - the length








getPower
IDataset getPower()
total power delivered by insertion device
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Returns:
the value.








setPower
DataNode setPower(IDataset power)
total power delivered by insertion device
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Parameters:
power - the power








getPowerScalar
java.lang.Double getPowerScalar()
total power delivered by insertion device
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Returns:
the value.








setPowerScalar
DataNode setPowerScalar(java.lang.Double power)
total power delivered by insertion device
 

 Type: NX_FLOAT
 Units: NX_POWER
 

Parameters:
power - the power








getEnergy
IDataset getEnergy()
energy of peak intensity in output spectrum
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setEnergy
DataNode setEnergy(IDataset energy)
energy of peak intensity in output spectrum
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
energy - the energy








getEnergyScalar
java.lang.Double getEnergyScalar()
energy of peak intensity in output spectrum
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setEnergyScalar
DataNode setEnergyScalar(java.lang.Double energy)
energy of peak intensity in output spectrum
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
energy - the energy








getBandwidth
IDataset getBandwidth()
bandwidth of peak energy
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setBandwidth
DataNode setBandwidth(IDataset bandwidth)
bandwidth of peak energy
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
bandwidth - the bandwidth








getBandwidthScalar
java.lang.Double getBandwidthScalar()
bandwidth of peak energy
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Returns:
the value.








setBandwidthScalar
DataNode setBandwidthScalar(java.lang.Double bandwidth)
bandwidth of peak energy
 

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Parameters:
bandwidth - the bandwidth








getHarmonic
IDataset getHarmonic()
harmonic number of peak
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Returns:
the value.








setHarmonic
DataNode setHarmonic(IDataset harmonic)
harmonic number of peak
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Parameters:
harmonic - the harmonic








getHarmonicScalar
java.lang.Long getHarmonicScalar()
harmonic number of peak
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Returns:
the value.








setHarmonicScalar
DataNode setHarmonicScalar(java.lang.Long harmonic)
harmonic number of peak
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Parameters:
harmonic - the harmonic








getSpectrum
NXdata getSpectrum()
spectrum of insertion device

Returns:
the value.








setSpectrum
void setSpectrum(NXdata spectrum)
spectrum of insertion device

Parameters:
spectrum - the spectrum








getGeometry
NXgeometry getGeometry()
"Engineering" position of insertion device

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)
"Engineering" position of insertion device

Parameters:
geometry - the geometry








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

 

 "Engineering" position of insertion device
 

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" position of insertion device
 

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" position of insertion device
 

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" position of insertion device
 

Parameters:
geometry - the child nodes to add














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