• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXmoderator.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.NXmoderator.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.nexus
Interface NXmoderator






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


All Known Implementing Classes:
NXmoderatorImpl




public interface NXmoderator
extends NXobject
A neutron moderator











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_COUPLED 


static java.lang.String
NX_COUPLING_MATERIAL 


static java.lang.String
NX_DISTANCE 


static java.lang.String
NX_POISON_DEPTH 


static java.lang.String
NX_POISON_MATERIAL 


static java.lang.String
NX_TEMPERATURE 


static java.lang.String
NX_TYPE 






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








Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


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



IDataset
getCoupled()
whether the moderator is coupled



java.lang.Boolean
getCoupledScalar()
whether the moderator is coupled



IDataset
getCoupling_material()
The material used for coupling.



java.lang.String
getCoupling_materialScalar()
The material used for coupling.



IDataset
getDistance()
Effective distance as seen by measuring radiation



java.lang.Double
getDistanceScalar()
Effective distance as seen by measuring radiation



NXgeometry
getGeometry()
"Engineering" position of moderator



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



IDataset
getPoison_depth()

 Type: NX_FLOAT
 Units: NX_LENGTH



java.lang.Double
getPoison_depthScalar()

 Type: NX_FLOAT
 Units: NX_LENGTH



IDataset
getPoison_material()


java.lang.String
getPoison_materialScalar()


NXdata
getPulse_shape()
moderator pulse shape



NXlog
getTemperature_log()
log file of moderator temperature



IDataset
getTemperature()
average/nominal moderator temperature



java.lang.Double
getTemperatureScalar()
average/nominal moderator temperature



IDataset
getType()


java.lang.String
getTypeScalar()


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



DataNode
setCoupled(IDataset coupled)
whether the moderator is coupled



DataNode
setCoupledScalar(java.lang.Boolean coupled)
whether the moderator is coupled



DataNode
setCoupling_material(IDataset coupling_material)
The material used for coupling.



DataNode
setCoupling_materialScalar(java.lang.String coupling_material)
The material used for coupling.



DataNode
setDistance(IDataset distance)
Effective distance as seen by measuring radiation



DataNode
setDistanceScalar(java.lang.Double distance)
Effective distance as seen by measuring radiation



void
setGeometry(NXgeometry geometry)
"Engineering" position of moderator



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



DataNode
setPoison_depth(IDataset poison_depth)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setPoison_depthScalar(java.lang.Double poison_depth)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setPoison_material(IDataset poison_material)


DataNode
setPoison_materialScalar(java.lang.String poison_material)


void
setPulse_shape(NXdata pulse_shape)
moderator pulse shape



void
setTemperature_log(NXlog temperature_log)
log file of moderator temperature



DataNode
setTemperature(IDataset temperature)
average/nominal moderator temperature



DataNode
setTemperatureScalar(java.lang.Double temperature)
average/nominal moderator temperature



DataNode
setType(IDataset type)


DataNode
setTypeScalar(java.lang.String type)






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





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





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





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














Field Detail





NX_DISTANCE
static final java.lang.String NX_DISTANCE

See Also:
Constant Field Values








NX_TYPE
static final java.lang.String NX_TYPE

See Also:
Constant Field Values








NX_POISON_DEPTH
static final java.lang.String NX_POISON_DEPTH

See Also:
Constant Field Values








NX_COUPLED
static final java.lang.String NX_COUPLED

See Also:
Constant Field Values








NX_COUPLING_MATERIAL
static final java.lang.String NX_COUPLING_MATERIAL

See Also:
Constant Field Values








NX_POISON_MATERIAL
static final java.lang.String NX_POISON_MATERIAL

See Also:
Constant Field Values








NX_TEMPERATURE
static final java.lang.String NX_TEMPERATURE

See Also:
Constant Field Values










Method Detail





getGeometry
NXgeometry getGeometry()
"Engineering" position of moderator

Returns:
the value.








setGeometry
void setGeometry(NXgeometry geometry)
"Engineering" position of moderator

Parameters:
geometry - the geometry








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

 

 "Engineering" position of moderator
 

Parameters:
name - the name of the node.
Returns:
a map from node names to the NXgeometry for that node.








setGeometry
void setGeometry(java.lang.String name,
                 NXgeometry geometry)
Set a NXgeometry node by name:
 

 

 "Engineering" position of moderator
 

Parameters:
name - the name of the node
geometry - the value to set








getAllGeometry
java.util.Map<java.lang.String,NXgeometry> getAllGeometry()
Get all NXgeometry nodes:
 

 

 "Engineering" position of moderator
 

Returns:
a map from node names to the NXgeometry for that node.








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

 

 "Engineering" position of moderator
 

Parameters:
geometry - the child nodes to add








getDistance
IDataset getDistance()
Effective distance as seen by measuring radiation
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistance
DataNode setDistance(IDataset distance)
Effective distance as seen by measuring radiation
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getDistanceScalar
java.lang.Double getDistanceScalar()
Effective distance as seen by measuring radiation
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setDistanceScalar
DataNode setDistanceScalar(java.lang.Double distance)
Effective distance as seen by measuring radiation
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
distance - the distance








getType
IDataset getType()

 
Enumeration:

 
H20 
 
D20 
 
Liquid H2 
 
Liquid CH4 
 
Liquid D2 
 
Solid D2 
 
C 
 
Solid CH4 
 
Solid H2 

 


Returns:
the value.








setType
DataNode setType(IDataset type)

 
Enumeration:

 
H20 
 
D20 
 
Liquid H2 
 
Liquid CH4 
 
Liquid D2 
 
Solid D2 
 
C 
 
Solid CH4 
 
Solid H2 

 


Parameters:
type - the type








getTypeScalar
java.lang.String getTypeScalar()

 
Enumeration:

 
H20 
 
D20 
 
Liquid H2 
 
Liquid CH4 
 
Liquid D2 
 
Solid D2 
 
C 
 
Solid CH4 
 
Solid H2 

 


Returns:
the value.








setTypeScalar
DataNode setTypeScalar(java.lang.String type)

 
Enumeration:

 
H20 
 
D20 
 
Liquid H2 
 
Liquid CH4 
 
Liquid D2 
 
Solid D2 
 
C 
 
Solid CH4 
 
Solid H2 

 


Parameters:
type - the type








getPoison_depth
IDataset getPoison_depth()

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setPoison_depth
DataNode setPoison_depth(IDataset poison_depth)

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
poison_depth - the poison_depth








getPoison_depthScalar
java.lang.Double getPoison_depthScalar()

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setPoison_depthScalar
DataNode setPoison_depthScalar(java.lang.Double poison_depth)

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
poison_depth - the poison_depth








getCoupled
IDataset getCoupled()
whether the moderator is coupled
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setCoupled
DataNode setCoupled(IDataset coupled)
whether the moderator is coupled
 

 Type: NX_BOOLEAN
 

Parameters:
coupled - the coupled








getCoupledScalar
java.lang.Boolean getCoupledScalar()
whether the moderator is coupled
 

 Type: NX_BOOLEAN
 

Returns:
the value.








setCoupledScalar
DataNode setCoupledScalar(java.lang.Boolean coupled)
whether the moderator is coupled
 

 Type: NX_BOOLEAN
 

Parameters:
coupled - the coupled








getCoupling_material
IDataset getCoupling_material()
The material used for coupling. Usually Cd.

Returns:
the value.








setCoupling_material
DataNode setCoupling_material(IDataset coupling_material)
The material used for coupling. Usually Cd.

Parameters:
coupling_material - the coupling_material








getCoupling_materialScalar
java.lang.String getCoupling_materialScalar()
The material used for coupling. Usually Cd.

Returns:
the value.








setCoupling_materialScalar
DataNode setCoupling_materialScalar(java.lang.String coupling_material)
The material used for coupling. Usually Cd.

Parameters:
coupling_material - the coupling_material








getPoison_material
IDataset getPoison_material()

 
Enumeration:

 
Gd 
 
Cd 

 


Returns:
the value.








setPoison_material
DataNode setPoison_material(IDataset poison_material)

 
Enumeration:

 
Gd 
 
Cd 

 


Parameters:
poison_material - the poison_material








getPoison_materialScalar
java.lang.String getPoison_materialScalar()

 
Enumeration:

 
Gd 
 
Cd 

 


Returns:
the value.








setPoison_materialScalar
DataNode setPoison_materialScalar(java.lang.String poison_material)

 
Enumeration:

 
Gd 
 
Cd 

 


Parameters:
poison_material - the poison_material








getTemperature
IDataset getTemperature()
average/nominal moderator temperature
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 

Returns:
the value.








setTemperature
DataNode setTemperature(IDataset temperature)
average/nominal moderator temperature
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 

Parameters:
temperature - the temperature








getTemperatureScalar
java.lang.Double getTemperatureScalar()
average/nominal moderator temperature
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 

Returns:
the value.








setTemperatureScalar
DataNode setTemperatureScalar(java.lang.Double temperature)
average/nominal moderator temperature
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 

Parameters:
temperature - the temperature








getTemperature_log
NXlog getTemperature_log()
log file of moderator temperature

Returns:
the value.








setTemperature_log
void setTemperature_log(NXlog temperature_log)
log file of moderator temperature

Parameters:
temperature_log - the temperature_log








getPulse_shape
NXdata getPulse_shape()
moderator pulse shape

Returns:
the value.








setPulse_shape
void setPulse_shape(NXdata pulse_shape)
moderator pulse shape

Parameters:
pulse_shape - the pulse_shape














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