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






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



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













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




public class NXgratingImpl
extends NXobjectImpl
implements NXgrating
A diffraction grating, as could be used in a soft X-ray monochromator

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.NXgrating
NX_ANGLES, NX_COATING_MATERIAL, NX_COATING_ROUGHNESS, NX_DEFLECTION_ANGLE, NX_DEPTH, NX_DIFFRACTION_ORDER, NX_DUTY_CYCLE, NX_INTERIOR_ATMOSPHERE, NX_LAYER_THICKNESS, NX_PERIOD, NX_SUBSTRATE_DENSITY, NX_SUBSTRATE_MATERIAL, NX_SUBSTRATE_ROUGHNESS, NX_SUBSTRATE_THICKNESS





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








Constructor Summary

Constructors 

Constructor and Description


NXgratingImpl() 


NXgratingImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXtransformations>
getAllTransformations()
Get all NXtransformations nodes:
 
 
 "Engineering" position of the grating
 



IDataset
getAngles()
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.



java.lang.Double
getAnglesScalar()
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.



IDataset
getCoating_material() 


java.lang.String
getCoating_materialScalar() 


IDataset
getCoating_roughness()

 Type: NX_FLOAT
 Units: NX_LENGTH



java.lang.Double
getCoating_roughnessScalar()

 Type: NX_FLOAT
 Units: NX_LENGTH



IDataset
getDeflection_angle()
Angle between the incident beam and the utilised outgoing beam.



java.lang.Double
getDeflection_angleScalar()
Angle between the incident beam and the utilised outgoing beam.



IDataset
getDepth()

 Type: NX_FLOAT
 Units: NX_LENGTH



java.lang.Double
getDepthScalar()

 Type: NX_FLOAT
 Units: NX_LENGTH



IDataset
getDiffraction_order()

 Type: NX_INT
 Units: NX_UNITLESS



java.lang.Long
getDiffraction_orderScalar()

 Type: NX_INT
 Units: NX_UNITLESS



IDataset
getDuty_cycle()

 Type: NX_FLOAT
 Units: NX_UNITLESS



java.lang.Double
getDuty_cycleScalar()

 Type: NX_FLOAT
 Units: NX_UNITLESS



NXdata
getFigure_data()
Numerical description of the surface figure of the mirror.



IDataset
getInterior_atmosphere()


java.lang.String
getInterior_atmosphereScalar()


IDataset
getLayer_thickness()
An array describing the thickness of each layer



java.lang.Double
getLayer_thicknessScalar()
An array describing the thickness of each layer



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.



IDataset
getPeriod()
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.



java.lang.Double
getPeriodScalar()
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



NXshape
getShape()
A NXshape group describing the shape of the mirror



IDataset
getSubstrate_density()

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY



java.lang.Double
getSubstrate_densityScalar()

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY



IDataset
getSubstrate_material() 


java.lang.String
getSubstrate_materialScalar() 


IDataset
getSubstrate_roughness()

 Type: NX_FLOAT
 Units: NX_LENGTH



java.lang.Double
getSubstrate_roughnessScalar()

 Type: NX_FLOAT
 Units: NX_LENGTH



IDataset
getSubstrate_thickness()

 Type: NX_FLOAT
 Units: NX_LENGTH



java.lang.Double
getSubstrate_thicknessScalar()

 Type: NX_FLOAT
 Units: NX_LENGTH



NXtransformations
getTransformations()
"Engineering" position of the grating



NXtransformations
getTransformations(java.lang.String name)
Get a NXtransformations node by name:
 
 
 "Engineering" position of the grating
 



void
setAllTransformations(java.util.Map<java.lang.String,NXtransformations> transformations)
Set multiple child nodes of a particular type.



DataNode
setAngles(IDataset angles)
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.



DataNode
setAnglesScalar(java.lang.Double angles)
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.



DataNode
setCoating_material(IDataset coating_material) 


DataNode
setCoating_materialScalar(java.lang.String coating_material) 


DataNode
setCoating_roughness(IDataset coating_roughness)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setCoating_roughnessScalar(java.lang.Double coating_roughness)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setDeflection_angle(IDataset deflection_angle)
Angle between the incident beam and the utilised outgoing beam.



DataNode
setDeflection_angleScalar(java.lang.Double deflection_angle)
Angle between the incident beam and the utilised outgoing beam.



DataNode
setDepth(IDataset depth)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setDepthScalar(java.lang.Double depth)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setDiffraction_order(IDataset diffraction_order)

 Type: NX_INT
 Units: NX_UNITLESS



DataNode
setDiffraction_orderScalar(java.lang.Long diffraction_order)

 Type: NX_INT
 Units: NX_UNITLESS



DataNode
setDuty_cycle(IDataset duty_cycle)

 Type: NX_FLOAT
 Units: NX_UNITLESS



DataNode
setDuty_cycleScalar(java.lang.Double duty_cycle)

 Type: NX_FLOAT
 Units: NX_UNITLESS



void
setFigure_data(NXdata figure_data)
Numerical description of the surface figure of the mirror.



DataNode
setInterior_atmosphere(IDataset interior_atmosphere)


DataNode
setInterior_atmosphereScalar(java.lang.String interior_atmosphere)


DataNode
setLayer_thickness(IDataset layer_thickness)
An array describing the thickness of each layer



DataNode
setLayer_thicknessScalar(java.lang.Double layer_thickness)
An array describing the thickness of each layer



DataNode
setPeriod(IDataset period)
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.



DataNode
setPeriodScalar(java.lang.Double period)
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.



void
setShape(NXshape shape)
A NXshape group describing the shape of the mirror



DataNode
setSubstrate_density(IDataset substrate_density)

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY



DataNode
setSubstrate_densityScalar(java.lang.Double substrate_density)

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY



DataNode
setSubstrate_material(IDataset substrate_material) 


DataNode
setSubstrate_materialScalar(java.lang.String substrate_material) 


DataNode
setSubstrate_roughness(IDataset substrate_roughness)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setSubstrate_thickness(IDataset substrate_thickness)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)

 Type: NX_FLOAT
 Units: NX_LENGTH



void
setTransformations(NXtransformations transformations)
"Engineering" position of the grating



void
setTransformations(java.lang.String name,
                  NXtransformations transformations)
Set a NXtransformations node by name:
 
 
 "Engineering" position of the grating
 







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





NXgratingImpl
public NXgratingImpl()







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








getAngles
public IDataset getAngles()
Description copied from interface: NXgrating
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2;
 

Specified by:
getAngles in interface NXgrating
Returns:
the value.








getAnglesScalar
public java.lang.Double getAnglesScalar()
Description copied from interface: NXgrating
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2;
 

Specified by:
getAnglesScalar in interface NXgrating
Returns:
the value.








setAngles
public DataNode setAngles(IDataset angles)
Description copied from interface: NXgrating
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2;
 

Specified by:
setAngles in interface NXgrating
Parameters:
angles - the angles








setAnglesScalar
public DataNode setAnglesScalar(java.lang.Double angles)
Description copied from interface: NXgrating
Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first. Blazed gratings can be identified by the low value of the first-listed angle.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 Dimensions: 1: 2;
 

Specified by:
setAnglesScalar in interface NXgrating
Parameters:
angles - the angles








getPeriod
public IDataset getPeriod()
Description copied from interface: NXgrating
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant).
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions:
 

Specified by:
getPeriod in interface NXgrating
Returns:
the value.








getPeriodScalar
public java.lang.Double getPeriodScalar()
Description copied from interface: NXgrating
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant).
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions:
 

Specified by:
getPeriodScalar in interface NXgrating
Returns:
the value.








setPeriod
public DataNode setPeriod(IDataset period)
Description copied from interface: NXgrating
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant).
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions:
 

Specified by:
setPeriod in interface NXgrating
Parameters:
period - the period








setPeriodScalar
public DataNode setPeriodScalar(java.lang.Double period)
Description copied from interface: NXgrating
List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position. Gratings which do not have variable line spacing will only have a single coefficient (constant).
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions:
 

Specified by:
setPeriodScalar in interface NXgrating
Parameters:
period - the period








getDuty_cycle
public IDataset getDuty_cycle()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_UNITLESS
 

Specified by:
getDuty_cycle in interface NXgrating
Returns:
the value.








getDuty_cycleScalar
public java.lang.Double getDuty_cycleScalar()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_UNITLESS
 

Specified by:
getDuty_cycleScalar in interface NXgrating
Returns:
the value.








setDuty_cycle
public DataNode setDuty_cycle(IDataset duty_cycle)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_UNITLESS
 

Specified by:
setDuty_cycle in interface NXgrating
Parameters:
duty_cycle - the duty_cycle








setDuty_cycleScalar
public DataNode setDuty_cycleScalar(java.lang.Double duty_cycle)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_UNITLESS
 

Specified by:
setDuty_cycleScalar in interface NXgrating
Parameters:
duty_cycle - the duty_cycle








getDepth
public IDataset getDepth()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDepth in interface NXgrating
Returns:
the value.








getDepthScalar
public java.lang.Double getDepthScalar()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDepthScalar in interface NXgrating
Returns:
the value.








setDepth
public DataNode setDepth(IDataset depth)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDepth in interface NXgrating
Parameters:
depth - the depth








setDepthScalar
public DataNode setDepthScalar(java.lang.Double depth)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDepthScalar in interface NXgrating
Parameters:
depth - the depth








getDiffraction_order
public IDataset getDiffraction_order()
Description copied from interface: NXgrating

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
getDiffraction_order in interface NXgrating
Returns:
the value.








getDiffraction_orderScalar
public java.lang.Long getDiffraction_orderScalar()
Description copied from interface: NXgrating

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
getDiffraction_orderScalar in interface NXgrating
Returns:
the value.








setDiffraction_order
public DataNode setDiffraction_order(IDataset diffraction_order)
Description copied from interface: NXgrating

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
setDiffraction_order in interface NXgrating
Parameters:
diffraction_order - the diffraction_order








setDiffraction_orderScalar
public DataNode setDiffraction_orderScalar(java.lang.Long diffraction_order)
Description copied from interface: NXgrating

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
setDiffraction_orderScalar in interface NXgrating
Parameters:
diffraction_order - the diffraction_order








getDeflection_angle
public IDataset getDeflection_angle()
Description copied from interface: NXgrating
Angle between the incident beam and the utilised outgoing beam.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDeflection_angle in interface NXgrating
Returns:
the value.








getDeflection_angleScalar
public java.lang.Double getDeflection_angleScalar()
Description copied from interface: NXgrating
Angle between the incident beam and the utilised outgoing beam.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDeflection_angleScalar in interface NXgrating
Returns:
the value.








setDeflection_angle
public DataNode setDeflection_angle(IDataset deflection_angle)
Description copied from interface: NXgrating
Angle between the incident beam and the utilised outgoing beam.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDeflection_angle in interface NXgrating
Parameters:
deflection_angle - the deflection_angle








setDeflection_angleScalar
public DataNode setDeflection_angleScalar(java.lang.Double deflection_angle)
Description copied from interface: NXgrating
Angle between the incident beam and the utilised outgoing beam.
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDeflection_angleScalar in interface NXgrating
Parameters:
deflection_angle - the deflection_angle








getInterior_atmosphere
public IDataset getInterior_atmosphere()
Description copied from interface: NXgrating

 
Enumeration:

 vacuum 
 helium 
 argon 

 

Specified by:
getInterior_atmosphere in interface NXgrating
Returns:
the value.








getInterior_atmosphereScalar
public java.lang.String getInterior_atmosphereScalar()
Description copied from interface: NXgrating

 
Enumeration:

 vacuum 
 helium 
 argon 

 

Specified by:
getInterior_atmosphereScalar in interface NXgrating
Returns:
the value.








setInterior_atmosphere
public DataNode setInterior_atmosphere(IDataset interior_atmosphere)
Description copied from interface: NXgrating

 
Enumeration:

 vacuum 
 helium 
 argon 

 

Specified by:
setInterior_atmosphere in interface NXgrating
Parameters:
interior_atmosphere - the interior_atmosphere








setInterior_atmosphereScalar
public DataNode setInterior_atmosphereScalar(java.lang.String interior_atmosphere)
Description copied from interface: NXgrating

 
Enumeration:

 vacuum 
 helium 
 argon 

 

Specified by:
setInterior_atmosphereScalar in interface NXgrating
Parameters:
interior_atmosphere - the interior_atmosphere








getSubstrate_material
public IDataset getSubstrate_material()

Specified by:
getSubstrate_material in interface NXgrating
Returns:
the value.








getSubstrate_materialScalar
public java.lang.String getSubstrate_materialScalar()

Specified by:
getSubstrate_materialScalar in interface NXgrating
Returns:
the value.








setSubstrate_material
public DataNode setSubstrate_material(IDataset substrate_material)

Specified by:
setSubstrate_material in interface NXgrating
Parameters:
substrate_material - the substrate_material








setSubstrate_materialScalar
public DataNode setSubstrate_materialScalar(java.lang.String substrate_material)

Specified by:
setSubstrate_materialScalar in interface NXgrating
Parameters:
substrate_material - the substrate_material








getSubstrate_density
public IDataset getSubstrate_density()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 

Specified by:
getSubstrate_density in interface NXgrating
Returns:
the value.








getSubstrate_densityScalar
public java.lang.Double getSubstrate_densityScalar()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 

Specified by:
getSubstrate_densityScalar in interface NXgrating
Returns:
the value.








setSubstrate_density
public DataNode setSubstrate_density(IDataset substrate_density)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 

Specified by:
setSubstrate_density in interface NXgrating
Parameters:
substrate_density - the substrate_density








setSubstrate_densityScalar
public DataNode setSubstrate_densityScalar(java.lang.Double substrate_density)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_MASS_DENSITY
 

Specified by:
setSubstrate_densityScalar in interface NXgrating
Parameters:
substrate_density - the substrate_density








getSubstrate_thickness
public IDataset getSubstrate_thickness()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSubstrate_thickness in interface NXgrating
Returns:
the value.








getSubstrate_thicknessScalar
public java.lang.Double getSubstrate_thicknessScalar()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSubstrate_thicknessScalar in interface NXgrating
Returns:
the value.








setSubstrate_thickness
public DataNode setSubstrate_thickness(IDataset substrate_thickness)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSubstrate_thickness in interface NXgrating
Parameters:
substrate_thickness - the substrate_thickness








setSubstrate_thicknessScalar
public DataNode setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSubstrate_thicknessScalar in interface NXgrating
Parameters:
substrate_thickness - the substrate_thickness








getCoating_material
public IDataset getCoating_material()

Specified by:
getCoating_material in interface NXgrating
Returns:
the value.








getCoating_materialScalar
public java.lang.String getCoating_materialScalar()

Specified by:
getCoating_materialScalar in interface NXgrating
Returns:
the value.








setCoating_material
public DataNode setCoating_material(IDataset coating_material)

Specified by:
setCoating_material in interface NXgrating
Parameters:
coating_material - the coating_material








setCoating_materialScalar
public DataNode setCoating_materialScalar(java.lang.String coating_material)

Specified by:
setCoating_materialScalar in interface NXgrating
Parameters:
coating_material - the coating_material








getSubstrate_roughness
public IDataset getSubstrate_roughness()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSubstrate_roughness in interface NXgrating
Returns:
the value.








getSubstrate_roughnessScalar
public java.lang.Double getSubstrate_roughnessScalar()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getSubstrate_roughnessScalar in interface NXgrating
Returns:
the value.








setSubstrate_roughness
public DataNode setSubstrate_roughness(IDataset substrate_roughness)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSubstrate_roughness in interface NXgrating
Parameters:
substrate_roughness - the substrate_roughness








setSubstrate_roughnessScalar
public DataNode setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setSubstrate_roughnessScalar in interface NXgrating
Parameters:
substrate_roughness - the substrate_roughness








getCoating_roughness
public IDataset getCoating_roughness()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getCoating_roughness in interface NXgrating
Returns:
the value.








getCoating_roughnessScalar
public java.lang.Double getCoating_roughnessScalar()
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getCoating_roughnessScalar in interface NXgrating
Returns:
the value.








setCoating_roughness
public DataNode setCoating_roughness(IDataset coating_roughness)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setCoating_roughness in interface NXgrating
Parameters:
coating_roughness - the coating_roughness








setCoating_roughnessScalar
public DataNode setCoating_roughnessScalar(java.lang.Double coating_roughness)
Description copied from interface: NXgrating

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setCoating_roughnessScalar in interface NXgrating
Parameters:
coating_roughness - the coating_roughness








getLayer_thickness
public IDataset getLayer_thickness()
Description copied from interface: NXgrating
An array describing the thickness of each layer
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getLayer_thickness in interface NXgrating
Returns:
the value.








getLayer_thicknessScalar
public java.lang.Double getLayer_thicknessScalar()
Description copied from interface: NXgrating
An array describing the thickness of each layer
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getLayer_thicknessScalar in interface NXgrating
Returns:
the value.








setLayer_thickness
public DataNode setLayer_thickness(IDataset layer_thickness)
Description copied from interface: NXgrating
An array describing the thickness of each layer
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setLayer_thickness in interface NXgrating
Parameters:
layer_thickness - the layer_thickness








setLayer_thicknessScalar
public DataNode setLayer_thicknessScalar(java.lang.Double layer_thickness)
Description copied from interface: NXgrating
An array describing the thickness of each layer
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setLayer_thicknessScalar in interface NXgrating
Parameters:
layer_thickness - the layer_thickness








getShape
public NXshape getShape()
Description copied from interface: NXgrating
A NXshape group describing the shape of the mirror

Specified by:
getShape in interface NXgrating
Returns:
the value.








setShape
public void setShape(NXshape shape)
Description copied from interface: NXgrating
A NXshape group describing the shape of the mirror

Specified by:
setShape in interface NXgrating
Parameters:
shape - the shape








getFigure_data
public NXdata getFigure_data()
Description copied from interface: NXgrating
Numerical description of the surface figure of the mirror.

Specified by:
getFigure_data in interface NXgrating
Returns:
the value.








setFigure_data
public void setFigure_data(NXdata figure_data)
Description copied from interface: NXgrating
Numerical description of the surface figure of the mirror.

Specified by:
setFigure_data in interface NXgrating
Parameters:
figure_data - the figure_data








getTransformations
public NXtransformations getTransformations()
Description copied from interface: NXgrating
"Engineering" position of the grating

Specified by:
getTransformations in interface NXgrating
Returns:
the value.








setTransformations
public void setTransformations(NXtransformations transformations)
Description copied from interface: NXgrating
"Engineering" position of the grating

Specified by:
setTransformations in interface NXgrating
Parameters:
transformations - the transformations








getTransformations
public NXtransformations getTransformations(java.lang.String name)
Description copied from interface: NXgrating
Get a NXtransformations node by name:
 
 
 "Engineering" position of the grating
 

Specified by:
getTransformations in interface NXgrating
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXtransformations for that node.








setTransformations
public void setTransformations(java.lang.String name,
                               NXtransformations transformations)
Description copied from interface: NXgrating
Set a NXtransformations node by name:
 
 
 "Engineering" position of the grating
 

Specified by:
setTransformations in interface NXgrating
Parameters:
name - the name of the node
transformations - the value to set








getAllTransformations
public java.util.Map<java.lang.String,NXtransformations> getAllTransformations()
Description copied from interface: NXgrating
Get all NXtransformations nodes:
 
 
 "Engineering" position of the grating
 

Specified by:
getAllTransformations in interface NXgrating
Returns:
a map from node names to the NXtransformations for that node.








setAllTransformations
public void setAllTransformations(java.util.Map<java.lang.String,NXtransformations> transformations)
Description copied from interface: NXgrating
Set multiple child nodes of a particular type.
 
 
 "Engineering" position of the grating
 

Specified by:
setAllTransformations in interface NXgrating
Parameters:
transformations - 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
`java.util.Map<java.lang.String,NXtransformations>`	`getAllTransformations()` Get all NXtransformations nodes: "Engineering" position of the grating
`IDataset`	`getAngles()` Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.
`java.lang.Double`	`getAnglesScalar()` Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.
`IDataset`	`getCoating_material()`
`java.lang.String`	`getCoating_materialScalar()`
`IDataset`	`getCoating_roughness()` Type: NX_FLOAT Units: NX_LENGTH
`java.lang.Double`	`getCoating_roughnessScalar()` Type: NX_FLOAT Units: NX_LENGTH
`IDataset`	`getDeflection_angle()` Angle between the incident beam and the utilised outgoing beam.
`java.lang.Double`	`getDeflection_angleScalar()` Angle between the incident beam and the utilised outgoing beam.
`IDataset`	`getDepth()` Type: NX_FLOAT Units: NX_LENGTH
`java.lang.Double`	`getDepthScalar()` Type: NX_FLOAT Units: NX_LENGTH
`IDataset`	`getDiffraction_order()` Type: NX_INT Units: NX_UNITLESS
`java.lang.Long`	`getDiffraction_orderScalar()` Type: NX_INT Units: NX_UNITLESS
`IDataset`	`getDuty_cycle()` Type: NX_FLOAT Units: NX_UNITLESS
`java.lang.Double`	`getDuty_cycleScalar()` Type: NX_FLOAT Units: NX_UNITLESS
`NXdata`	`getFigure_data()` Numerical description of the surface figure of the mirror.
`IDataset`	`getInterior_atmosphere()`
`java.lang.String`	`getInterior_atmosphereScalar()`
`IDataset`	`getLayer_thickness()` An array describing the thickness of each layer
`java.lang.Double`	`getLayer_thicknessScalar()` An array describing the thickness of each layer
`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.
`IDataset`	`getPeriod()` List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.
`java.lang.Double`	`getPeriodScalar()` List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.
`java.util.Set<NexusBaseClass>`	`getPermittedChildGroupClasses()` Returns a set containing the `NexusBaseClass` constants for the permitted child group types of this base class.
`NXshape`	`getShape()` A NXshape group describing the shape of the mirror
`IDataset`	`getSubstrate_density()` Type: NX_FLOAT Units: NX_MASS_DENSITY
`java.lang.Double`	`getSubstrate_densityScalar()` Type: NX_FLOAT Units: NX_MASS_DENSITY
`IDataset`	`getSubstrate_material()`
`java.lang.String`	`getSubstrate_materialScalar()`
`IDataset`	`getSubstrate_roughness()` Type: NX_FLOAT Units: NX_LENGTH
`java.lang.Double`	`getSubstrate_roughnessScalar()` Type: NX_FLOAT Units: NX_LENGTH
`IDataset`	`getSubstrate_thickness()` Type: NX_FLOAT Units: NX_LENGTH
`java.lang.Double`	`getSubstrate_thicknessScalar()` Type: NX_FLOAT Units: NX_LENGTH
`NXtransformations`	`getTransformations()` "Engineering" position of the grating
`NXtransformations`	`getTransformations(java.lang.String name)` Get a NXtransformations node by name: "Engineering" position of the grating
`void`	`setAllTransformations(java.util.Map<java.lang.String,NXtransformations> transformations)` Set multiple child nodes of a particular type.
`DataNode`	`setAngles(IDataset angles)` Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.
`DataNode`	`setAnglesScalar(java.lang.Double angles)` Blaze or trapezoidal angles, with the angle of the upstream facing edge listed first.
`DataNode`	`setCoating_material(IDataset coating_material)`
`DataNode`	`setCoating_materialScalar(java.lang.String coating_material)`
`DataNode`	`setCoating_roughness(IDataset coating_roughness)` Type: NX_FLOAT Units: NX_LENGTH
`DataNode`	`setCoating_roughnessScalar(java.lang.Double coating_roughness)` Type: NX_FLOAT Units: NX_LENGTH
`DataNode`	`setDeflection_angle(IDataset deflection_angle)` Angle between the incident beam and the utilised outgoing beam.
`DataNode`	`setDeflection_angleScalar(java.lang.Double deflection_angle)` Angle between the incident beam and the utilised outgoing beam.
`DataNode`	`setDepth(IDataset depth)` Type: NX_FLOAT Units: NX_LENGTH
`DataNode`	`setDepthScalar(java.lang.Double depth)` Type: NX_FLOAT Units: NX_LENGTH
`DataNode`	`setDiffraction_order(IDataset diffraction_order)` Type: NX_INT Units: NX_UNITLESS
`DataNode`	`setDiffraction_orderScalar(java.lang.Long diffraction_order)` Type: NX_INT Units: NX_UNITLESS
`DataNode`	`setDuty_cycle(IDataset duty_cycle)` Type: NX_FLOAT Units: NX_UNITLESS
`DataNode`	`setDuty_cycleScalar(java.lang.Double duty_cycle)` Type: NX_FLOAT Units: NX_UNITLESS
`void`	`setFigure_data(NXdata figure_data)` Numerical description of the surface figure of the mirror.
`DataNode`	`setInterior_atmosphere(IDataset interior_atmosphere)`
`DataNode`	`setInterior_atmosphereScalar(java.lang.String interior_atmosphere)`
`DataNode`	`setLayer_thickness(IDataset layer_thickness)` An array describing the thickness of each layer
`DataNode`	`setLayer_thicknessScalar(java.lang.Double layer_thickness)` An array describing the thickness of each layer
`DataNode`	`setPeriod(IDataset period)` List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.
`DataNode`	`setPeriodScalar(java.lang.Double period)` List of polynomial coefficients describing the spatial separation of lines/grooves as a function of position along the grating, in increasing powers of position.
`void`	`setShape(NXshape shape)` A NXshape group describing the shape of the mirror
`DataNode`	`setSubstrate_density(IDataset substrate_density)` Type: NX_FLOAT Units: NX_MASS_DENSITY
`DataNode`	`setSubstrate_densityScalar(java.lang.Double substrate_density)` Type: NX_FLOAT Units: NX_MASS_DENSITY
`DataNode`	`setSubstrate_material(IDataset substrate_material)`
`DataNode`	`setSubstrate_materialScalar(java.lang.String substrate_material)`
`DataNode`	`setSubstrate_roughness(IDataset substrate_roughness)` Type: NX_FLOAT Units: NX_LENGTH
`DataNode`	`setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)` Type: NX_FLOAT Units: NX_LENGTH
`DataNode`	`setSubstrate_thickness(IDataset substrate_thickness)` Type: NX_FLOAT Units: NX_LENGTH
`DataNode`	`setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)` Type: NX_FLOAT Units: NX_LENGTH
`void`	`setTransformations(NXtransformations transformations)` "Engineering" position of the grating
`void`	`setTransformations(java.lang.String name, NXtransformations transformations)` Set a NXtransformations node by name: "Engineering" position of the grating

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