• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXguideImpl.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.nexus.impl
Class NXguideImpl



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













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




public class NXguideImpl
extends NXobjectImpl
implements NXguide
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`.

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.NXguide
NX_BEND_ANGLE_X, NX_BEND_ANGLE_Y, NX_COATING_MATERIAL, NX_COATING_ROUGHNESS, NX_DESCRIPTION, NX_EXTERNAL_MATERIAL, NX_INCIDENT_ANGLE, NX_INTERIOR_ATMOSPHERE, NX_M_VALUE, NX_NUMBER_SECTIONS, 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


NXguideImpl() 


NXguideImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete 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.



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



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)



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.



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





NXguideImpl
public NXguideImpl()







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








getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXguide
TODO: Explain what this NXgeometry group means. What is intended here?

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








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXguide
TODO: Explain what this NXgeometry group means. What is intended here?

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








getGeometry
public NXgeometry getGeometry(java.lang.String name)
Description copied from interface: NXguide
Get a NXgeometry node by name:
 

 

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

Specified by:
getGeometry in interface NXguide
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: NXguide
Set a NXgeometry node by name:
 

 

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

Specified by:
setGeometry in interface NXguide
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: NXguide
Get all NXgeometry nodes:
 

 

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

Specified by:
getAllGeometry in interface NXguide
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: NXguide
Set multiple child nodes of a particular type.
 

 

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

Specified by:
setAllGeometry in interface NXguide
Parameters:
geometry - the child nodes to add








getDescription
public IDataset getDescription()
Description copied from interface: NXguide
A description of this particular instance of ``NXguide``.

Specified by:
getDescription in interface NXguide
Returns:
the value.








getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXguide
A description of this particular instance of ``NXguide``.

Specified by:
getDescriptionScalar in interface NXguide
Returns:
the value.








setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXguide
A description of this particular instance of ``NXguide``.

Specified by:
setDescription in interface NXguide
Parameters:
description - the description








setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXguide
A description of this particular instance of ``NXguide``.

Specified by:
setDescriptionScalar in interface NXguide
Parameters:
description - the description








getIncident_angle
public IDataset getIncident_angle()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getIncident_angle in interface NXguide
Returns:
the value.








getIncident_angleScalar
public java.lang.Double getIncident_angleScalar()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getIncident_angleScalar in interface NXguide
Returns:
the value.








setIncident_angle
public DataNode setIncident_angle(IDataset incident_angle)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setIncident_angle in interface NXguide
Parameters:
incident_angle - the incident_angle








setIncident_angleScalar
public DataNode setIncident_angleScalar(java.lang.Double incident_angle)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setIncident_angleScalar in interface NXguide
Parameters:
incident_angle - the incident_angle








getReflectivity
public NXdata getReflectivity()
Description copied from interface: NXguide
Reflectivity as function of reflecting surface and wavelength

Specified by:
getReflectivity in interface NXguide
Returns:
the value.








setReflectivity
public void setReflectivity(NXdata reflectivity)
Description copied from interface: NXguide
Reflectivity as function of reflecting surface and wavelength

Specified by:
setReflectivity in interface NXguide
Parameters:
reflectivity - the reflectivity








getBend_angle_x
public IDataset getBend_angle_x()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getBend_angle_x in interface NXguide
Returns:
the value.








getBend_angle_xScalar
public java.lang.Double getBend_angle_xScalar()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getBend_angle_xScalar in interface NXguide
Returns:
the value.








setBend_angle_x
public DataNode setBend_angle_x(IDataset bend_angle_x)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setBend_angle_x in interface NXguide
Parameters:
bend_angle_x - the bend_angle_x








setBend_angle_xScalar
public DataNode setBend_angle_xScalar(java.lang.Double bend_angle_x)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setBend_angle_xScalar in interface NXguide
Parameters:
bend_angle_x - the bend_angle_x








getBend_angle_y
public IDataset getBend_angle_y()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getBend_angle_y in interface NXguide
Returns:
the value.








getBend_angle_yScalar
public java.lang.Double getBend_angle_yScalar()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getBend_angle_yScalar in interface NXguide
Returns:
the value.








setBend_angle_y
public DataNode setBend_angle_y(IDataset bend_angle_y)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setBend_angle_y in interface NXguide
Parameters:
bend_angle_y - the bend_angle_y








setBend_angle_yScalar
public DataNode setBend_angle_yScalar(java.lang.Double bend_angle_y)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setBend_angle_yScalar in interface NXguide
Parameters:
bend_angle_y - the bend_angle_y








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

 
Enumeration:

 
vacuum 
 
helium 
 
argon 

 


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








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

 
Enumeration:

 
vacuum 
 
helium 
 
argon 

 


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








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

 
Enumeration:

 
vacuum 
 
helium 
 
argon 

 


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








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

 
Enumeration:

 
vacuum 
 
helium 
 
argon 

 


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








getExternal_material
public IDataset getExternal_material()
Description copied from interface: NXguide
external material outside substrate

Specified by:
getExternal_material in interface NXguide
Returns:
the value.








getExternal_materialScalar
public java.lang.String getExternal_materialScalar()
Description copied from interface: NXguide
external material outside substrate

Specified by:
getExternal_materialScalar in interface NXguide
Returns:
the value.








setExternal_material
public DataNode setExternal_material(IDataset external_material)
Description copied from interface: NXguide
external material outside substrate

Specified by:
setExternal_material in interface NXguide
Parameters:
external_material - the external_material








setExternal_materialScalar
public DataNode setExternal_materialScalar(java.lang.String external_material)
Description copied from interface: NXguide
external material outside substrate

Specified by:
setExternal_materialScalar in interface NXguide
Parameters:
external_material - the external_material








getM_value
public IDataset getM_value()
Description copied from interface: NXguide
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;
 

Specified by:
getM_value in interface NXguide
Returns:
the value.








getM_valueScalar
public java.lang.Double getM_valueScalar()
Description copied from interface: NXguide
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;
 

Specified by:
getM_valueScalar in interface NXguide
Returns:
the value.








setM_value
public DataNode setM_value(IDataset m_value)
Description copied from interface: NXguide
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;
 

Specified by:
setM_value in interface NXguide
Parameters:
m_value - the m_value








setM_valueScalar
public DataNode setM_valueScalar(java.lang.Double m_value)
Description copied from interface: NXguide
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;
 

Specified by:
setM_valueScalar in interface NXguide
Parameters:
m_value - the m_value








getSubstrate_material
public IDataset getSubstrate_material()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

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








getSubstrate_materialScalar
public java.lang.Double getSubstrate_materialScalar()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

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








setSubstrate_material
public DataNode setSubstrate_material(IDataset substrate_material)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

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








setSubstrate_materialScalar
public DataNode setSubstrate_materialScalar(java.lang.Double substrate_material)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

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








getSubstrate_thickness
public IDataset getSubstrate_thickness()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








getSubstrate_thicknessScalar
public java.lang.Double getSubstrate_thicknessScalar()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








setSubstrate_thickness
public DataNode setSubstrate_thickness(IDataset substrate_thickness)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








setSubstrate_thicknessScalar
public DataNode setSubstrate_thicknessScalar(java.lang.Double substrate_thickness)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








getCoating_material
public IDataset getCoating_material()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

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








getCoating_materialScalar
public java.lang.Double getCoating_materialScalar()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

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








setCoating_material
public DataNode setCoating_material(IDataset coating_material)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

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








setCoating_materialScalar
public DataNode setCoating_materialScalar(java.lang.Double coating_material)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Dimensions: 1: nsurf;
 

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








getSubstrate_roughness
public IDataset getSubstrate_roughness()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








getSubstrate_roughnessScalar
public java.lang.Double getSubstrate_roughnessScalar()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








setSubstrate_roughness
public DataNode setSubstrate_roughness(IDataset substrate_roughness)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








setSubstrate_roughnessScalar
public DataNode setSubstrate_roughnessScalar(java.lang.Double substrate_roughness)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








getCoating_roughness
public IDataset getCoating_roughness()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








getCoating_roughnessScalar
public java.lang.Double getCoating_roughnessScalar()
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








setCoating_roughness
public DataNode setCoating_roughness(IDataset coating_roughness)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








setCoating_roughnessScalar
public DataNode setCoating_roughnessScalar(java.lang.Double coating_roughness)
Description copied from interface: NXguide
TODO: documentation needed
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 Dimensions: 1: nsurf;
 

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








getNumber_sections
public IDataset getNumber_sections()
Description copied from interface: NXguide
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
getNumber_sections in interface NXguide
Returns:
the value.








getNumber_sectionsScalar
public java.lang.Long getNumber_sectionsScalar()
Description copied from interface: NXguide
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
getNumber_sectionsScalar in interface NXguide
Returns:
the value.








setNumber_sections
public DataNode setNumber_sections(IDataset number_sections)
Description copied from interface: NXguide
number of substrate sections (also called ``nsurf`` as an
 index in the ``NXguide`` specification)
 

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
setNumber_sections in interface NXguide
Parameters:
number_sections - the number_sections








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

 Type: NX_INT
 Units: NX_UNITLESS
 

Specified by:
setNumber_sectionsScalar in interface NXguide
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