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






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



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













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




public class NXbending_magnetImpl
extends NXobjectImpl
implements NXbending_magnet
A bending magnet

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.NXbending_magnet
NX_ACCEPTED_PHOTON_BEAM_DIVERGENCE, NX_BENDING_RADIUS, NX_CRITICAL_ENERGY, NX_DIVERGENCE_X_MINUS, NX_DIVERGENCE_X_PLUS, NX_DIVERGENCE_Y_MINUS, NX_DIVERGENCE_Y_PLUS, NX_MAGNETIC_FIELD, NX_SOURCE_DISTANCE_X, NX_SOURCE_DISTANCE_Y





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








Constructor Summary

Constructors 

Constructor and Description


NXbending_magnetImpl() 


NXbending_magnetImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getAccepted_photon_beam_divergence()
An array of four numbers giving X+, X-, Y+ and Y- half divergence



java.lang.Double
getAccepted_photon_beam_divergenceScalar()
An array of four numbers giving X+, X-, Y+ and Y- half divergence



java.util.Map<java.lang.String,NXgeometry>
getAllGeometry()
Get all NXgeometry nodes:
 
 
 "Engineering" position of bending magnet
 



IDataset
getBending_radius()

 Type: NX_FLOAT
 Units: NX_LENGTH



java.lang.Double
getBending_radiusScalar()

 Type: NX_FLOAT
 Units: NX_LENGTH



IDataset
getCritical_energy()

 Type: NX_FLOAT
 Units: NX_ENERGY



java.lang.Double
getCritical_energyScalar()

 Type: NX_FLOAT
 Units: NX_ENERGY



IDataset
getDivergence_x_minus()
Accepted photon beam divergence in X- (horizontal inboard) direction.



java.lang.Double
getDivergence_x_minusScalar()
Accepted photon beam divergence in X- (horizontal inboard) direction.



IDataset
getDivergence_x_plus()
Accepted photon beam divergence in X+ (horizontal outboard) direction.



java.lang.Double
getDivergence_x_plusScalar()
Accepted photon beam divergence in X+ (horizontal outboard) direction.



IDataset
getDivergence_y_minus()
Accepted photon beam divergence in Y- (vertical downward) direction.



java.lang.Double
getDivergence_y_minusScalar()
Accepted photon beam divergence in Y- (vertical downward) direction.



IDataset
getDivergence_y_plus()
Accepted photon beam divergence in Y+ (vertical upward) direction.



java.lang.Double
getDivergence_y_plusScalar()
Accepted photon beam divergence in Y+ (vertical upward) direction.



NXgeometry
getGeometry()
"Engineering" position of bending magnet



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



IDataset
getMagnetic_field()
strength of magnetic field of dipole magnets



java.lang.Double
getMagnetic_fieldScalar()
strength of magnetic field of dipole magnets



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
getSource_distance_x()
Distance of source point from particle beam waist in X (horizontal) direction.



java.lang.Double
getSource_distance_xScalar()
Distance of source point from particle beam waist in X (horizontal) direction.



IDataset
getSource_distance_y()
Distance of source point from particle beam waist in Y (vertical) direction.



java.lang.Double
getSource_distance_yScalar()
Distance of source point from particle beam waist in Y (vertical) direction.



NXdata
getSpectrum()
bending magnet spectrum



DataNode
setAccepted_photon_beam_divergence(IDataset accepted_photon_beam_divergence)
An array of four numbers giving X+, X-, Y+ and Y- half divergence



DataNode
setAccepted_photon_beam_divergenceScalar(java.lang.Double accepted_photon_beam_divergence)
An array of four numbers giving X+, X-, Y+ and Y- half divergence



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



DataNode
setBending_radius(IDataset bending_radius)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setBending_radiusScalar(java.lang.Double bending_radius)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setCritical_energy(IDataset critical_energy)

 Type: NX_FLOAT
 Units: NX_ENERGY



DataNode
setCritical_energyScalar(java.lang.Double critical_energy)

 Type: NX_FLOAT
 Units: NX_ENERGY



DataNode
setDivergence_x_minus(IDataset divergence_x_minus)
Accepted photon beam divergence in X- (horizontal inboard) direction.



DataNode
setDivergence_x_minusScalar(java.lang.Double divergence_x_minus)
Accepted photon beam divergence in X- (horizontal inboard) direction.



DataNode
setDivergence_x_plus(IDataset divergence_x_plus)
Accepted photon beam divergence in X+ (horizontal outboard) direction.



DataNode
setDivergence_x_plusScalar(java.lang.Double divergence_x_plus)
Accepted photon beam divergence in X+ (horizontal outboard) direction.



DataNode
setDivergence_y_minus(IDataset divergence_y_minus)
Accepted photon beam divergence in Y- (vertical downward) direction.



DataNode
setDivergence_y_minusScalar(java.lang.Double divergence_y_minus)
Accepted photon beam divergence in Y- (vertical downward) direction.



DataNode
setDivergence_y_plus(IDataset divergence_y_plus)
Accepted photon beam divergence in Y+ (vertical upward) direction.



DataNode
setDivergence_y_plusScalar(java.lang.Double divergence_y_plus)
Accepted photon beam divergence in Y+ (vertical upward) direction.



void
setGeometry(NXgeometry geometry)
"Engineering" position of bending magnet



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



DataNode
setMagnetic_field(IDataset magnetic_field)
strength of magnetic field of dipole magnets



DataNode
setMagnetic_fieldScalar(java.lang.Double magnetic_field)
strength of magnetic field of dipole magnets



DataNode
setSource_distance_x(IDataset source_distance_x)
Distance of source point from particle beam waist in X (horizontal) direction.



DataNode
setSource_distance_xScalar(java.lang.Double source_distance_x)
Distance of source point from particle beam waist in X (horizontal) direction.



DataNode
setSource_distance_y(IDataset source_distance_y)
Distance of source point from particle beam waist in Y (vertical) direction.



DataNode
setSource_distance_yScalar(java.lang.Double source_distance_y)
Distance of source point from particle beam waist in Y (vertical) direction.



void
setSpectrum(NXdata spectrum)
bending magnet spectrum







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





NXbending_magnetImpl
public NXbending_magnetImpl()







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








getCritical_energy
public IDataset getCritical_energy()
Description copied from interface: NXbending_magnet

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
getCritical_energy in interface NXbending_magnet
Returns:
the value.








getCritical_energyScalar
public java.lang.Double getCritical_energyScalar()
Description copied from interface: NXbending_magnet

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
getCritical_energyScalar in interface NXbending_magnet
Returns:
the value.








setCritical_energy
public DataNode setCritical_energy(IDataset critical_energy)
Description copied from interface: NXbending_magnet

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
setCritical_energy in interface NXbending_magnet
Parameters:
critical_energy - the critical_energy








setCritical_energyScalar
public DataNode setCritical_energyScalar(java.lang.Double critical_energy)
Description copied from interface: NXbending_magnet

 Type: NX_FLOAT
 Units: NX_ENERGY
 

Specified by:
setCritical_energyScalar in interface NXbending_magnet
Parameters:
critical_energy - the critical_energy








getBending_radius
public IDataset getBending_radius()
Description copied from interface: NXbending_magnet

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getBending_radius in interface NXbending_magnet
Returns:
the value.








getBending_radiusScalar
public java.lang.Double getBending_radiusScalar()
Description copied from interface: NXbending_magnet

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getBending_radiusScalar in interface NXbending_magnet
Returns:
the value.








setBending_radius
public DataNode setBending_radius(IDataset bending_radius)
Description copied from interface: NXbending_magnet

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setBending_radius in interface NXbending_magnet
Parameters:
bending_radius - the bending_radius








setBending_radiusScalar
public DataNode setBending_radiusScalar(java.lang.Double bending_radius)
Description copied from interface: NXbending_magnet

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setBending_radiusScalar in interface NXbending_magnet
Parameters:
bending_radius - the bending_radius








getMagnetic_field
public IDataset getMagnetic_field()
Description copied from interface: NXbending_magnet
strength of magnetic field of dipole magnets
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getMagnetic_field in interface NXbending_magnet
Returns:
the value.








getMagnetic_fieldScalar
public java.lang.Double getMagnetic_fieldScalar()
Description copied from interface: NXbending_magnet
strength of magnetic field of dipole magnets
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
getMagnetic_fieldScalar in interface NXbending_magnet
Returns:
the value.








setMagnetic_field
public DataNode setMagnetic_field(IDataset magnetic_field)
Description copied from interface: NXbending_magnet
strength of magnetic field of dipole magnets
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setMagnetic_field in interface NXbending_magnet
Parameters:
magnetic_field - the magnetic_field








setMagnetic_fieldScalar
public DataNode setMagnetic_fieldScalar(java.lang.Double magnetic_field)
Description copied from interface: NXbending_magnet
strength of magnetic field of dipole magnets
 
 Type: NX_FLOAT
 Units: NX_CURRENT
 

Specified by:
setMagnetic_fieldScalar in interface NXbending_magnet
Parameters:
magnetic_field - the magnetic_field








getAccepted_photon_beam_divergence
public IDataset getAccepted_photon_beam_divergence()
Description copied from interface: NXbending_magnet
An array of four numbers giving X+, X-, Y+ and Y- half divergence
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getAccepted_photon_beam_divergence in interface NXbending_magnet
Returns:
the value.








getAccepted_photon_beam_divergenceScalar
public java.lang.Double getAccepted_photon_beam_divergenceScalar()
Description copied from interface: NXbending_magnet
An array of four numbers giving X+, X-, Y+ and Y- half divergence
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getAccepted_photon_beam_divergenceScalar in interface NXbending_magnet
Returns:
the value.








setAccepted_photon_beam_divergence
public DataNode setAccepted_photon_beam_divergence(IDataset accepted_photon_beam_divergence)
Description copied from interface: NXbending_magnet
An array of four numbers giving X+, X-, Y+ and Y- half divergence
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setAccepted_photon_beam_divergence in interface NXbending_magnet
Parameters:
accepted_photon_beam_divergence - the accepted_photon_beam_divergence








setAccepted_photon_beam_divergenceScalar
public DataNode setAccepted_photon_beam_divergenceScalar(java.lang.Double accepted_photon_beam_divergence)
Description copied from interface: NXbending_magnet
An array of four numbers giving X+, X-, Y+ and Y- half divergence
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setAccepted_photon_beam_divergenceScalar in interface NXbending_magnet
Parameters:
accepted_photon_beam_divergence - the accepted_photon_beam_divergence








getSource_distance_x
public IDataset getSource_distance_x()
Description copied from interface: NXbending_magnet
Distance of source point from particle beam waist in X (horizontal) direction.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSource_distance_x in interface NXbending_magnet
Returns:
the value.








getSource_distance_xScalar
public java.lang.Double getSource_distance_xScalar()
Description copied from interface: NXbending_magnet
Distance of source point from particle beam waist in X (horizontal) direction.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSource_distance_xScalar in interface NXbending_magnet
Returns:
the value.








setSource_distance_x
public DataNode setSource_distance_x(IDataset source_distance_x)
Description copied from interface: NXbending_magnet
Distance of source point from particle beam waist in X (horizontal) direction.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSource_distance_x in interface NXbending_magnet
Parameters:
source_distance_x - the source_distance_x








setSource_distance_xScalar
public DataNode setSource_distance_xScalar(java.lang.Double source_distance_x)
Description copied from interface: NXbending_magnet
Distance of source point from particle beam waist in X (horizontal) direction.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSource_distance_xScalar in interface NXbending_magnet
Parameters:
source_distance_x - the source_distance_x








getSource_distance_y
public IDataset getSource_distance_y()
Description copied from interface: NXbending_magnet
Distance of source point from particle beam waist in Y (vertical) direction.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSource_distance_y in interface NXbending_magnet
Returns:
the value.








getSource_distance_yScalar
public java.lang.Double getSource_distance_yScalar()
Description copied from interface: NXbending_magnet
Distance of source point from particle beam waist in Y (vertical) direction.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSource_distance_yScalar in interface NXbending_magnet
Returns:
the value.








setSource_distance_y
public DataNode setSource_distance_y(IDataset source_distance_y)
Description copied from interface: NXbending_magnet
Distance of source point from particle beam waist in Y (vertical) direction.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSource_distance_y in interface NXbending_magnet
Parameters:
source_distance_y - the source_distance_y








setSource_distance_yScalar
public DataNode setSource_distance_yScalar(java.lang.Double source_distance_y)
Description copied from interface: NXbending_magnet
Distance of source point from particle beam waist in Y (vertical) direction.
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSource_distance_yScalar in interface NXbending_magnet
Parameters:
source_distance_y - the source_distance_y








getDivergence_x_plus
public IDataset getDivergence_x_plus()
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in X+ (horizontal outboard) direction.
 Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_x_plus in interface NXbending_magnet
Returns:
the value.








getDivergence_x_plusScalar
public java.lang.Double getDivergence_x_plusScalar()
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in X+ (horizontal outboard) direction.
 Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_x_plusScalar in interface NXbending_magnet
Returns:
the value.








setDivergence_x_plus
public DataNode setDivergence_x_plus(IDataset divergence_x_plus)
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in X+ (horizontal outboard) direction.
 Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_x_plus in interface NXbending_magnet
Parameters:
divergence_x_plus - the divergence_x_plus








setDivergence_x_plusScalar
public DataNode setDivergence_x_plusScalar(java.lang.Double divergence_x_plus)
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in X+ (horizontal outboard) direction.
 Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_x_plusScalar in interface NXbending_magnet
Parameters:
divergence_x_plus - the divergence_x_plus








getDivergence_x_minus
public IDataset getDivergence_x_minus()
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in X- (horizontal inboard) direction.
 Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_x_minus in interface NXbending_magnet
Returns:
the value.








getDivergence_x_minusScalar
public java.lang.Double getDivergence_x_minusScalar()
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in X- (horizontal inboard) direction.
 Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_x_minusScalar in interface NXbending_magnet
Returns:
the value.








setDivergence_x_minus
public DataNode setDivergence_x_minus(IDataset divergence_x_minus)
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in X- (horizontal inboard) direction.
 Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_x_minus in interface NXbending_magnet
Parameters:
divergence_x_minus - the divergence_x_minus








setDivergence_x_minusScalar
public DataNode setDivergence_x_minusScalar(java.lang.Double divergence_x_minus)
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in X- (horizontal inboard) direction.
 Note that divergence_x_plus+divergence_x_minus is the total horizontal beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_x_minusScalar in interface NXbending_magnet
Parameters:
divergence_x_minus - the divergence_x_minus








getDivergence_y_plus
public IDataset getDivergence_y_plus()
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in Y+ (vertical upward) direction.
 Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_y_plus in interface NXbending_magnet
Returns:
the value.








getDivergence_y_plusScalar
public java.lang.Double getDivergence_y_plusScalar()
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in Y+ (vertical upward) direction.
 Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_y_plusScalar in interface NXbending_magnet
Returns:
the value.








setDivergence_y_plus
public DataNode setDivergence_y_plus(IDataset divergence_y_plus)
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in Y+ (vertical upward) direction.
 Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_y_plus in interface NXbending_magnet
Parameters:
divergence_y_plus - the divergence_y_plus








setDivergence_y_plusScalar
public DataNode setDivergence_y_plusScalar(java.lang.Double divergence_y_plus)
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in Y+ (vertical upward) direction.
 Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_y_plusScalar in interface NXbending_magnet
Parameters:
divergence_y_plus - the divergence_y_plus








getDivergence_y_minus
public IDataset getDivergence_y_minus()
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in Y- (vertical downward) direction.
 Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_y_minus in interface NXbending_magnet
Returns:
the value.








getDivergence_y_minusScalar
public java.lang.Double getDivergence_y_minusScalar()
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in Y- (vertical downward) direction.
 Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_y_minusScalar in interface NXbending_magnet
Returns:
the value.








setDivergence_y_minus
public DataNode setDivergence_y_minus(IDataset divergence_y_minus)
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in Y- (vertical downward) direction.
 Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_y_minus in interface NXbending_magnet
Parameters:
divergence_y_minus - the divergence_y_minus








setDivergence_y_minusScalar
public DataNode setDivergence_y_minusScalar(java.lang.Double divergence_y_minus)
Description copied from interface: NXbending_magnet
Accepted photon beam divergence in Y- (vertical downward) direction.
 Note that divergence_y_plus+divergence_y_minus is the total vertical beam divergence.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_y_minusScalar in interface NXbending_magnet
Parameters:
divergence_y_minus - the divergence_y_minus








getSpectrum
public NXdata getSpectrum()
Description copied from interface: NXbending_magnet
bending magnet spectrum

Specified by:
getSpectrum in interface NXbending_magnet
Returns:
the value.








setSpectrum
public void setSpectrum(NXdata spectrum)
Description copied from interface: NXbending_magnet
bending magnet spectrum

Specified by:
setSpectrum in interface NXbending_magnet
Parameters:
spectrum - the spectrum








getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXbending_magnet
"Engineering" position of bending magnet

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








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXbending_magnet
"Engineering" position of bending magnet

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








getGeometry
public NXgeometry getGeometry(java.lang.String name)
Description copied from interface: NXbending_magnet
Get a NXgeometry node by name:
 
 
 "Engineering" position of bending magnet
 

Specified by:
getGeometry in interface NXbending_magnet
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: NXbending_magnet
Set a NXgeometry node by name:
 
 
 "Engineering" position of bending magnet
 

Specified by:
setGeometry in interface NXbending_magnet
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: NXbending_magnet
Get all NXgeometry nodes:
 
 
 "Engineering" position of bending magnet
 

Specified by:
getAllGeometry in interface NXbending_magnet
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: NXbending_magnet
Set multiple child nodes of a particular type.
 
 
 "Engineering" position of bending magnet
 

Specified by:
setAllGeometry in interface NXbending_magnet
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

Modifier and Type	Method and Description
`IDataset`	`getAccepted_photon_beam_divergence()` An array of four numbers giving X+, X-, Y+ and Y- half divergence
`java.lang.Double`	`getAccepted_photon_beam_divergenceScalar()` An array of four numbers giving X+, X-, Y+ and Y- half divergence
`java.util.Map<java.lang.String,NXgeometry>`	`getAllGeometry()` Get all NXgeometry nodes: "Engineering" position of bending magnet
`IDataset`	`getBending_radius()` Type: NX_FLOAT Units: NX_LENGTH
`java.lang.Double`	`getBending_radiusScalar()` Type: NX_FLOAT Units: NX_LENGTH
`IDataset`	`getCritical_energy()` Type: NX_FLOAT Units: NX_ENERGY
`java.lang.Double`	`getCritical_energyScalar()` Type: NX_FLOAT Units: NX_ENERGY
`IDataset`	`getDivergence_x_minus()` Accepted photon beam divergence in X- (horizontal inboard) direction.
`java.lang.Double`	`getDivergence_x_minusScalar()` Accepted photon beam divergence in X- (horizontal inboard) direction.
`IDataset`	`getDivergence_x_plus()` Accepted photon beam divergence in X+ (horizontal outboard) direction.
`java.lang.Double`	`getDivergence_x_plusScalar()` Accepted photon beam divergence in X+ (horizontal outboard) direction.
`IDataset`	`getDivergence_y_minus()` Accepted photon beam divergence in Y- (vertical downward) direction.
`java.lang.Double`	`getDivergence_y_minusScalar()` Accepted photon beam divergence in Y- (vertical downward) direction.
`IDataset`	`getDivergence_y_plus()` Accepted photon beam divergence in Y+ (vertical upward) direction.
`java.lang.Double`	`getDivergence_y_plusScalar()` Accepted photon beam divergence in Y+ (vertical upward) direction.
`NXgeometry`	`getGeometry()` "Engineering" position of bending magnet
`NXgeometry`	`getGeometry(java.lang.String name)` Get a NXgeometry node by name: "Engineering" position of bending magnet
`IDataset`	`getMagnetic_field()` strength of magnetic field of dipole magnets
`java.lang.Double`	`getMagnetic_fieldScalar()` strength of magnetic field of dipole magnets
`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`	`getSource_distance_x()` Distance of source point from particle beam waist in X (horizontal) direction.
`java.lang.Double`	`getSource_distance_xScalar()` Distance of source point from particle beam waist in X (horizontal) direction.
`IDataset`	`getSource_distance_y()` Distance of source point from particle beam waist in Y (vertical) direction.
`java.lang.Double`	`getSource_distance_yScalar()` Distance of source point from particle beam waist in Y (vertical) direction.
`NXdata`	`getSpectrum()` bending magnet spectrum
`DataNode`	`setAccepted_photon_beam_divergence(IDataset accepted_photon_beam_divergence)` An array of four numbers giving X+, X-, Y+ and Y- half divergence
`DataNode`	`setAccepted_photon_beam_divergenceScalar(java.lang.Double accepted_photon_beam_divergence)` An array of four numbers giving X+, X-, Y+ and Y- half divergence
`void`	`setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)` Set multiple child nodes of a particular type.
`DataNode`	`setBending_radius(IDataset bending_radius)` Type: NX_FLOAT Units: NX_LENGTH
`DataNode`	`setBending_radiusScalar(java.lang.Double bending_radius)` Type: NX_FLOAT Units: NX_LENGTH
`DataNode`	`setCritical_energy(IDataset critical_energy)` Type: NX_FLOAT Units: NX_ENERGY
`DataNode`	`setCritical_energyScalar(java.lang.Double critical_energy)` Type: NX_FLOAT Units: NX_ENERGY
`DataNode`	`setDivergence_x_minus(IDataset divergence_x_minus)` Accepted photon beam divergence in X- (horizontal inboard) direction.
`DataNode`	`setDivergence_x_minusScalar(java.lang.Double divergence_x_minus)` Accepted photon beam divergence in X- (horizontal inboard) direction.
`DataNode`	`setDivergence_x_plus(IDataset divergence_x_plus)` Accepted photon beam divergence in X+ (horizontal outboard) direction.
`DataNode`	`setDivergence_x_plusScalar(java.lang.Double divergence_x_plus)` Accepted photon beam divergence in X+ (horizontal outboard) direction.
`DataNode`	`setDivergence_y_minus(IDataset divergence_y_minus)` Accepted photon beam divergence in Y- (vertical downward) direction.
`DataNode`	`setDivergence_y_minusScalar(java.lang.Double divergence_y_minus)` Accepted photon beam divergence in Y- (vertical downward) direction.
`DataNode`	`setDivergence_y_plus(IDataset divergence_y_plus)` Accepted photon beam divergence in Y+ (vertical upward) direction.
`DataNode`	`setDivergence_y_plusScalar(java.lang.Double divergence_y_plus)` Accepted photon beam divergence in Y+ (vertical upward) direction.
`void`	`setGeometry(NXgeometry geometry)` "Engineering" position of bending magnet
`void`	`setGeometry(java.lang.String name, NXgeometry geometry)` Set a NXgeometry node by name: "Engineering" position of bending magnet
`DataNode`	`setMagnetic_field(IDataset magnetic_field)` strength of magnetic field of dipole magnets
`DataNode`	`setMagnetic_fieldScalar(java.lang.Double magnetic_field)` strength of magnetic field of dipole magnets
`DataNode`	`setSource_distance_x(IDataset source_distance_x)` Distance of source point from particle beam waist in X (horizontal) direction.
`DataNode`	`setSource_distance_xScalar(java.lang.Double source_distance_x)` Distance of source point from particle beam waist in X (horizontal) direction.
`DataNode`	`setSource_distance_y(IDataset source_distance_y)` Distance of source point from particle beam waist in Y (vertical) direction.
`DataNode`	`setSource_distance_yScalar(java.lang.Double source_distance_y)` Distance of source point from particle beam waist in Y (vertical) direction.
`void`	`setSpectrum(NXdata spectrum)` bending magnet spectrum

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