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






NXguide (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
Interface NXguide






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


All Known Implementing Classes:
NXguideImpl




public interface NXguide
extends NXobject
A neutron optical element to direct the path of the beam.
 :ref:`NXguide` is used by neutron instruments to describe
 a guide consists of several mirrors building a shape through which
 neutrons can be guided or directed. The simplest such form is box shaped
 although elliptical guides are gaining in popularity.
 The individual parts of a guide usually have common characteristics
 but there are cases where they are different.
 For example, a neutron guide might consist of 2 or 4 coated walls or
 a supermirror bender with multiple, coated vanes.
 To describe polarizing supermirrors such as used in neutron reflection,
 it may be necessary to revise this definition of :ref:`NXguide`
 to include :ref:`NXpolarizer` and/or :ref:`NXmirror`.
 When even greater complexity exists in the definition of what
 constitutes a *guide*, it has been suggested that :ref:`NXguide`
 be redefined as a :ref:`NXcollection` of :ref:`NXmirror` each
 having their own :ref:`NXgeometry` describing their location(s).
 For the more general case when describing mirrors, consider using
 :ref:`NXmirror`.
 NOTE: The NeXus International Advisory Committee welcomes
 comments for revision and improvement of
 this definition of :ref:`NXguide`.
 Symbols: 

 nsurf 
 number of reflecting surfaces
 nwl 
 number of wavelengths












Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_BEND_ANGLE_X 


static java.lang.String
NX_BEND_ANGLE_Y 


static java.lang.String
NX_COATING_MATERIAL 


static java.lang.String
NX_COATING_ROUGHNESS 


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_EXTERNAL_MATERIAL 


static java.lang.String
NX_INCIDENT_ANGLE 


static java.lang.String
NX_INTERIOR_ATMOSPHERE 


static java.lang.String
NX_M_VALUE 


static java.lang.String
NX_NUMBER_SECTIONS 


static java.lang.String
NX_SUBSTRATE_MATERIAL 


static java.lang.String
NX_SUBSTRATE_ROUGHNESS 


static java.lang.String
NX_SUBSTRATE_THICKNESS 






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:
 
 
 TODO: Explain what this NXgeometry group means.



IDataset
getBend_angle_x()
TODO: documentation needed



java.lang.Double
getBend_angle_xScalar()
TODO: documentation needed



IDataset
getBend_angle_y()
TODO: documentation needed



java.lang.Double
getBend_angle_yScalar()
TODO: documentation needed



IDataset
getCoating_material()
TODO: documentation needed



java.lang.Double
getCoating_materialScalar()
TODO: documentation needed



IDataset
getCoating_roughness()
TODO: documentation needed



java.lang.Double
getCoating_roughnessScalar()
TODO: documentation needed



IDataset
getDescription()
A description of this particular instance of ``NXguide``.



java.lang.String
getDescriptionScalar()
A description of this particular instance of ``NXguide``.



IDataset
getExternal_material()
external material outside substrate



java.lang.String
getExternal_materialScalar()
external material outside substrate



NXgeometry
getGeometry()
TODO: Explain what this NXgeometry group means.



NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 TODO: Explain what this NXgeometry group means.



IDataset
getIncident_angle()
TODO: documentation needed



java.lang.Double
getIncident_angleScalar()
TODO: documentation needed



IDataset
getInterior_atmosphere()


java.lang.String
getInterior_atmosphereScalar()


IDataset
getM_value()
The ``m`` value for a supermirror, which defines the supermirror
 regime in multiples of the critical angle of Nickel.



java.lang.Double
getM_valueScalar()
The ``m`` value for a supermirror, which defines the supermirror
 regime in multiples of the critical angle of Nickel.



IDataset
getNumber_sections()
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)



java.lang.Long
getNumber_sectionsScalar()
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)



NXdata
getReflectivity()
Reflectivity as function of reflecting surface and wavelength



IDataset
getSubstrate_material()
TODO: documentation needed



java.lang.Double
getSubstrate_materialScalar()
TODO: documentation needed



IDataset
getSubstrate_roughness()
TODO: documentation needed



java.lang.Double
getSubstrate_roughnessScalar()
TODO: documentation needed



IDataset
getSubstrate_thickness()
TODO: documentation needed



java.lang.Double
getSubstrate_thicknessScalar()
TODO: documentation needed



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



DataNode
setBend_angle_x(IDataset bend_angle_x)
TODO: documentation needed



DataNode
setBend_angle_xScalar(java.lang.Double bend_angle_x)
TODO: documentation needed



DataNode
setBend_angle_y(IDataset bend_angle_y)
TODO: documentation needed



DataNode
setBend_angle_yScalar(java.lang.Double bend_angle_y)
TODO: documentation needed



DataNode
setCoating_material(IDataset coating_material)
TODO: documentation needed



DataNode
setCoating_materialScalar(java.lang.Double coating_material)
TODO: documentation needed



DataNode
setCoating_roughness(IDataset coating_roughness)
TODO: documentation needed



DataNode
setCoating_roughnessScalar(java.lang.Double coating_roughness)
TODO: documentation needed



DataNode
setDescription(IDataset description)
A description of this particular instance of ``NXguide``.



DataNode
setDescriptionScalar(java.lang.String description)
A description of this particular instance of ``NXguide``.



DataNode
setExternal_material(IDataset external_material)
external material outside substrate



DataNode
setExternal_materialScalar(java.lang.String external_material)
external material outside substrate



void
setGeometry(NXgeometry geometry)
TODO: Explain what this NXgeometry group means.



void
setGeometry(java.lang.String name,
           NXgeometry geometry)
Set a NXgeometry node by name:
 
 
 TODO: Explain what this NXgeometry group means.



DataNode
setIncident_angle(IDataset incident_angle)
TODO: documentation needed



DataNode
setIncident_angleScalar(java.lang.Double incident_angle)
TODO: documentation needed



DataNode
setInterior_atmosphere(IDataset interior_atmosphere)


DataNode
setInterior_atmosphereScalar(java.lang.String interior_atmosphere)


DataNode
setM_value(IDataset m_value)
The ``m`` value for a supermirror, which defines the supermirror
 regime in multiples of the critical angle of Nickel.



DataNode
setM_valueScalar(java.lang.Double m_value)
The ``m`` value for a supermirror, which defines the supermirror
 regime in multiples of the critical angle of Nickel.



DataNode
setNumber_sections(IDataset number_sections)
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)



DataNode
setNumber_sectionsScalar(java.lang.Long number_sections)
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)



void
setReflectivity(NXdata reflectivity)
Reflectivity as function of reflecting surface and wavelength



DataNode
setSubstrate_material(IDataset substrate_material)
TODO: documentation needed



DataNode
setSubstrate_materialScalar(java.lang.Double substrate_material)
TODO: documentation needed



DataNode
setSubstrate_roughness(IDataset substrate_roughness)
TODO: documentation needed



DataNode
setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)
TODO: documentation needed



DataNode
setSubstrate_thickness(IDataset substrate_thickness)
TODO: documentation needed



DataNode
setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)
TODO: documentation needed







Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNexusBaseClass, getNumber, getNXclass, getPermittedChildGroupClasses, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setField





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool





Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode





Methods inherited from interface java.lang.Iterable
forEach, spliterator














Field Detail





NX_DESCRIPTION
static final java.lang.String NX_DESCRIPTION

See Also:
Constant Field Values








NX_INCIDENT_ANGLE
static final java.lang.String NX_INCIDENT_ANGLE

See Also:
Constant Field Values








NX_BEND_ANGLE_X
static final java.lang.String NX_BEND_ANGLE_X

See Also:
Constant Field Values








NX_BEND_ANGLE_Y
static final java.lang.String NX_BEND_ANGLE_Y

See Also:
Constant Field Values








NX_INTERIOR_ATMOSPHERE
static final java.lang.String NX_INTERIOR_ATMOSPHERE

See Also:
Constant Field Values








NX_EXTERNAL_MATERIAL
static final java.lang.String NX_EXTERNAL_MATERIAL

See Also:
Constant Field Values








NX_M_VALUE
static final java.lang.String NX_M_VALUE

See Also:
Constant Field Values








NX_SUBSTRATE_MATERIAL
static final java.lang.String NX_SUBSTRATE_MATERIAL

See Also:
Constant Field Values








NX_SUBSTRATE_THICKNESS
static final java.lang.String NX_SUBSTRATE_THICKNESS

See Also:
Constant Field Values








NX_COATING_MATERIAL
static final java.lang.String NX_COATING_MATERIAL

See Also:
Constant Field Values








NX_SUBSTRATE_ROUGHNESS
static final java.lang.String NX_SUBSTRATE_ROUGHNESS

See Also:
Constant Field Values








NX_COATING_ROUGHNESS
static final java.lang.String NX_COATING_ROUGHNESS

See Also:
Constant Field Values








NX_NUMBER_SECTIONS
static final java.lang.String NX_NUMBER_SECTIONS

See Also:
Constant Field Values










Method Detail





getGeometry
NXgeometry getGeometry()
TODO: Explain what this NXgeometry group means. What is intended here?

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)
TODO: Explain what this NXgeometry group means. What is intended here?

Parameters:
geometry - the geometry








getGeometry
NXgeometry getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 TODO: Explain what this NXgeometry group means. What is intended here?
 

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:
 
 
 TODO: Explain what this NXgeometry group means. What is intended here?
 

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:
 
 
 TODO: Explain what this NXgeometry group means. What is intended here?
 

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.
 
 
 TODO: Explain what this NXgeometry group means. What is intended here?
 

Parameters:
geometry - the child nodes to add








getDescription
IDataset getDescription()
A description of this particular instance of ``NXguide``.

Returns:
the value.








setDescription
DataNode setDescription(IDataset description)
A description of this particular instance of ``NXguide``.

Parameters:
description - the description








getDescriptionScalar
java.lang.String getDescriptionScalar()
A description of this particular instance of ``NXguide``.

Returns:
the value.








setDescriptionScalar
DataNode setDescriptionScalar(java.lang.String description)
A description of this particular instance of ``NXguide``.

Parameters:
description - the description








getIncident_angle
IDataset getIncident_angle()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setIncident_angle
DataNode setIncident_angle(IDataset incident_angle)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
incident_angle - the incident_angle








getIncident_angleScalar
java.lang.Double getIncident_angleScalar()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setIncident_angleScalar
DataNode setIncident_angleScalar(java.lang.Double incident_angle)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
incident_angle - the incident_angle








getReflectivity
NXdata getReflectivity()
Reflectivity as function of reflecting surface and wavelength

Returns:
the value.








setReflectivity
void setReflectivity(NXdata reflectivity)
Reflectivity as function of reflecting surface and wavelength

Parameters:
reflectivity - the reflectivity








getBend_angle_x
IDataset getBend_angle_x()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setBend_angle_x
DataNode setBend_angle_x(IDataset bend_angle_x)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
bend_angle_x - the bend_angle_x








getBend_angle_xScalar
java.lang.Double getBend_angle_xScalar()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setBend_angle_xScalar
DataNode setBend_angle_xScalar(java.lang.Double bend_angle_x)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
bend_angle_x - the bend_angle_x








getBend_angle_y
IDataset getBend_angle_y()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setBend_angle_y
DataNode setBend_angle_y(IDataset bend_angle_y)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
bend_angle_y - the bend_angle_y








getBend_angle_yScalar
java.lang.Double getBend_angle_yScalar()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Returns:
the value.








setBend_angle_yScalar
DataNode setBend_angle_yScalar(java.lang.Double bend_angle_y)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_ANGLE
 

Parameters:
bend_angle_y - the bend_angle_y








getInterior_atmosphere
IDataset getInterior_atmosphere()

 
Enumeration:

 vacuum 
 helium 
 argon 

 

Returns:
the value.








setInterior_atmosphere
DataNode setInterior_atmosphere(IDataset interior_atmosphere)

 
Enumeration:

 vacuum 
 helium 
 argon 

 

Parameters:
interior_atmosphere - the interior_atmosphere








getInterior_atmosphereScalar
java.lang.String getInterior_atmosphereScalar()

 
Enumeration:

 vacuum 
 helium 
 argon 

 

Returns:
the value.








setInterior_atmosphereScalar
DataNode setInterior_atmosphereScalar(java.lang.String interior_atmosphere)

 
Enumeration:

 vacuum 
 helium 
 argon 

 

Parameters:
interior_atmosphere - the interior_atmosphere








getExternal_material
IDataset getExternal_material()
external material outside substrate

Returns:
the value.








setExternal_material
DataNode setExternal_material(IDataset external_material)
external material outside substrate

Parameters:
external_material - the external_material








getExternal_materialScalar
java.lang.String getExternal_materialScalar()
external material outside substrate

Returns:
the value.








setExternal_materialScalar
DataNode setExternal_materialScalar(java.lang.String external_material)
external material outside substrate

Parameters:
external_material - the external_material








getM_value
IDataset getM_value()
The ``m`` value for a supermirror, which defines the supermirror
 regime in multiples of the critical angle of Nickel.
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Returns:
the value.








setM_value
DataNode setM_value(IDataset m_value)
The ``m`` value for a supermirror, which defines the supermirror
 regime in multiples of the critical angle of Nickel.
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Parameters:
m_value - the m_value








getM_valueScalar
java.lang.Double getM_valueScalar()
The ``m`` value for a supermirror, which defines the supermirror
 regime in multiples of the critical angle of Nickel.
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Returns:
the value.








setM_valueScalar
DataNode setM_valueScalar(java.lang.Double m_value)
The ``m`` value for a supermirror, which defines the supermirror
 regime in multiples of the critical angle of Nickel.
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Parameters:
m_value - the m_value








getSubstrate_material
IDataset getSubstrate_material()
TODO: documentation needed
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Returns:
the value.








setSubstrate_material
DataNode setSubstrate_material(IDataset substrate_material)
TODO: documentation needed
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Parameters:
substrate_material - the substrate_material








getSubstrate_materialScalar
java.lang.Double getSubstrate_materialScalar()
TODO: documentation needed
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Returns:
the value.








setSubstrate_materialScalar
DataNode setSubstrate_materialScalar(java.lang.Double substrate_material)
TODO: documentation needed
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Parameters:
substrate_material - the substrate_material








getSubstrate_thickness
IDataset getSubstrate_thickness()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Returns:
the value.








setSubstrate_thickness
DataNode setSubstrate_thickness(IDataset substrate_thickness)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Parameters:
substrate_thickness - the substrate_thickness








getSubstrate_thicknessScalar
java.lang.Double getSubstrate_thicknessScalar()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Returns:
the value.








setSubstrate_thicknessScalar
DataNode setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Parameters:
substrate_thickness - the substrate_thickness








getCoating_material
IDataset getCoating_material()
TODO: documentation needed
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Returns:
the value.








setCoating_material
DataNode setCoating_material(IDataset coating_material)
TODO: documentation needed
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Parameters:
coating_material - the coating_material








getCoating_materialScalar
java.lang.Double getCoating_materialScalar()
TODO: documentation needed
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Returns:
the value.








setCoating_materialScalar
DataNode setCoating_materialScalar(java.lang.Double coating_material)
TODO: documentation needed
 
 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

Parameters:
coating_material - the coating_material








getSubstrate_roughness
IDataset getSubstrate_roughness()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Returns:
the value.








setSubstrate_roughness
DataNode setSubstrate_roughness(IDataset substrate_roughness)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Parameters:
substrate_roughness - the substrate_roughness








getSubstrate_roughnessScalar
java.lang.Double getSubstrate_roughnessScalar()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Returns:
the value.








setSubstrate_roughnessScalar
DataNode setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Parameters:
substrate_roughness - the substrate_roughness








getCoating_roughness
IDataset getCoating_roughness()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Returns:
the value.








setCoating_roughness
DataNode setCoating_roughness(IDataset coating_roughness)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Parameters:
coating_roughness - the coating_roughness








getCoating_roughnessScalar
java.lang.Double getCoating_roughnessScalar()
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Returns:
the value.








setCoating_roughnessScalar
DataNode setCoating_roughnessScalar(java.lang.Double coating_roughness)
TODO: documentation needed
 
 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

Parameters:
coating_roughness - the coating_roughness








getNumber_sections
IDataset getNumber_sections()
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)
 
 Type: NX_INT
 Units: NX_UNITLESS
 

Returns:
the value.








setNumber_sections
DataNode setNumber_sections(IDataset number_sections)
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)
 
 Type: NX_INT
 Units: NX_UNITLESS
 

Parameters:
number_sections - the number_sections








getNumber_sectionsScalar
java.lang.Long getNumber_sectionsScalar()
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)
 
 Type: NX_INT
 Units: NX_UNITLESS
 

Returns:
the value.








setNumber_sectionsScalar
DataNode setNumber_sectionsScalar(java.lang.Long number_sections)
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)
 
 Type: NX_INT
 Units: NX_UNITLESS
 

Parameters:
number_sections - the number_sections














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	Field and Description
`static java.lang.String`	`NX_BEND_ANGLE_X`
`static java.lang.String`	`NX_BEND_ANGLE_Y`
`static java.lang.String`	`NX_COATING_MATERIAL`
`static java.lang.String`	`NX_COATING_ROUGHNESS`
`static java.lang.String`	`NX_DESCRIPTION`
`static java.lang.String`	`NX_EXTERNAL_MATERIAL`
`static java.lang.String`	`NX_INCIDENT_ANGLE`
`static java.lang.String`	`NX_INTERIOR_ATMOSPHERE`
`static java.lang.String`	`NX_M_VALUE`
`static java.lang.String`	`NX_NUMBER_SECTIONS`
`static java.lang.String`	`NX_SUBSTRATE_MATERIAL`
`static java.lang.String`	`NX_SUBSTRATE_ROUGHNESS`
`static java.lang.String`	`NX_SUBSTRATE_THICKNESS`

Modifier and Type	Method and Description
`java.util.Map<java.lang.String,NXgeometry>`	`getAllGeometry()` Get all NXgeometry nodes: TODO: Explain what this NXgeometry group means.
`IDataset`	`getBend_angle_x()` TODO: documentation needed
`java.lang.Double`	`getBend_angle_xScalar()` TODO: documentation needed
`IDataset`	`getBend_angle_y()` TODO: documentation needed
`java.lang.Double`	`getBend_angle_yScalar()` TODO: documentation needed
`IDataset`	`getCoating_material()` TODO: documentation needed
`java.lang.Double`	`getCoating_materialScalar()` TODO: documentation needed
`IDataset`	`getCoating_roughness()` TODO: documentation needed
`java.lang.Double`	`getCoating_roughnessScalar()` TODO: documentation needed
`IDataset`	`getDescription()` A description of this particular instance of ``NXguide``.
`java.lang.String`	`getDescriptionScalar()` A description of this particular instance of ``NXguide``.
`IDataset`	`getExternal_material()` external material outside substrate
`java.lang.String`	`getExternal_materialScalar()` external material outside substrate
`NXgeometry`	`getGeometry()` TODO: Explain what this NXgeometry group means.
`NXgeometry`	`getGeometry(java.lang.String name)` Get a NXgeometry node by name: TODO: Explain what this NXgeometry group means.
`IDataset`	`getIncident_angle()` TODO: documentation needed
`java.lang.Double`	`getIncident_angleScalar()` TODO: documentation needed
`IDataset`	`getInterior_atmosphere()`
`java.lang.String`	`getInterior_atmosphereScalar()`
`IDataset`	`getM_value()` The ``m`` value for a supermirror, which defines the supermirror regime in multiples of the critical angle of Nickel.
`java.lang.Double`	`getM_valueScalar()` The ``m`` value for a supermirror, which defines the supermirror regime in multiples of the critical angle of Nickel.
`IDataset`	`getNumber_sections()` number of substrate sections (also called ``nsurf`` as an index in the ``NXguide`` specification)
`java.lang.Long`	`getNumber_sectionsScalar()` number of substrate sections (also called ``nsurf`` as an index in the ``NXguide`` specification)
`NXdata`	`getReflectivity()` Reflectivity as function of reflecting surface and wavelength
`IDataset`	`getSubstrate_material()` TODO: documentation needed
`java.lang.Double`	`getSubstrate_materialScalar()` TODO: documentation needed
`IDataset`	`getSubstrate_roughness()` TODO: documentation needed
`java.lang.Double`	`getSubstrate_roughnessScalar()` TODO: documentation needed
`IDataset`	`getSubstrate_thickness()` TODO: documentation needed
`java.lang.Double`	`getSubstrate_thicknessScalar()` TODO: documentation needed
`void`	`setAllGeometry(java.util.Map<java.lang.String,NXgeometry> geometry)` Set multiple child nodes of a particular type.
`DataNode`	`setBend_angle_x(IDataset bend_angle_x)` TODO: documentation needed
`DataNode`	`setBend_angle_xScalar(java.lang.Double bend_angle_x)` TODO: documentation needed
`DataNode`	`setBend_angle_y(IDataset bend_angle_y)` TODO: documentation needed
`DataNode`	`setBend_angle_yScalar(java.lang.Double bend_angle_y)` TODO: documentation needed
`DataNode`	`setCoating_material(IDataset coating_material)` TODO: documentation needed
`DataNode`	`setCoating_materialScalar(java.lang.Double coating_material)` TODO: documentation needed
`DataNode`	`setCoating_roughness(IDataset coating_roughness)` TODO: documentation needed
`DataNode`	`setCoating_roughnessScalar(java.lang.Double coating_roughness)` TODO: documentation needed
`DataNode`	`setDescription(IDataset description)` A description of this particular instance of ``NXguide``.
`DataNode`	`setDescriptionScalar(java.lang.String description)` A description of this particular instance of ``NXguide``.
`DataNode`	`setExternal_material(IDataset external_material)` external material outside substrate
`DataNode`	`setExternal_materialScalar(java.lang.String external_material)` external material outside substrate
`void`	`setGeometry(NXgeometry geometry)` TODO: Explain what this NXgeometry group means.
`void`	`setGeometry(java.lang.String name, NXgeometry geometry)` Set a NXgeometry node by name: TODO: Explain what this NXgeometry group means.
`DataNode`	`setIncident_angle(IDataset incident_angle)` TODO: documentation needed
`DataNode`	`setIncident_angleScalar(java.lang.Double incident_angle)` TODO: documentation needed
`DataNode`	`setInterior_atmosphere(IDataset interior_atmosphere)`
`DataNode`	`setInterior_atmosphereScalar(java.lang.String interior_atmosphere)`
`DataNode`	`setM_value(IDataset m_value)` The ``m`` value for a supermirror, which defines the supermirror regime in multiples of the critical angle of Nickel.
`DataNode`	`setM_valueScalar(java.lang.Double m_value)` The ``m`` value for a supermirror, which defines the supermirror regime in multiples of the critical angle of Nickel.
`DataNode`	`setNumber_sections(IDataset number_sections)` number of substrate sections (also called ``nsurf`` as an index in the ``NXguide`` specification)
`DataNode`	`setNumber_sectionsScalar(java.lang.Long number_sections)` number of substrate sections (also called ``nsurf`` as an index in the ``NXguide`` specification)
`void`	`setReflectivity(NXdata reflectivity)` Reflectivity as function of reflecting surface and wavelength
`DataNode`	`setSubstrate_material(IDataset substrate_material)` TODO: documentation needed
`DataNode`	`setSubstrate_materialScalar(java.lang.Double substrate_material)` TODO: documentation needed
`DataNode`	`setSubstrate_roughness(IDataset substrate_roughness)` TODO: documentation needed
`DataNode`	`setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)` TODO: documentation needed
`DataNode`	`setSubstrate_thickness(IDataset substrate_thickness)` TODO: documentation needed
`DataNode`	`setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)` TODO: documentation needed