• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXmoderatorImpl.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.NXmoderatorImpl.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 NXmoderatorImpl



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













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




public class NXmoderatorImpl
extends NXobjectImpl
implements NXmoderator
A neutron moderator

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.NXmoderator
NX_COUPLED, NX_COUPLING_MATERIAL, NX_DISTANCE, NX_POISON_DEPTH, NX_POISON_MATERIAL, NX_TEMPERATURE, NX_TYPE





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








Constructor Summary

Constructors 

Constructor and Description


NXmoderatorImpl() 


NXmoderatorImpl(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:
 
 
 "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
 



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



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



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



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





NXmoderatorImpl
public NXmoderatorImpl()







NXmoderatorImpl
public NXmoderatorImpl(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: NXmoderator
"Engineering" position of moderator

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








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXmoderator
"Engineering" position of moderator

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








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

 

 "Engineering" position of moderator
 

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

 

 "Engineering" position of moderator
 

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

 

 "Engineering" position of moderator
 

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

 

 "Engineering" position of moderator
 

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








getDistance
public IDataset getDistance()
Description copied from interface: NXmoderator
Effective distance as seen by measuring radiation
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDistance in interface NXmoderator
Returns:
the value.








getDistanceScalar
public java.lang.Double getDistanceScalar()
Description copied from interface: NXmoderator
Effective distance as seen by measuring radiation
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getDistanceScalar in interface NXmoderator
Returns:
the value.








setDistance
public DataNode setDistance(IDataset distance)
Description copied from interface: NXmoderator
Effective distance as seen by measuring radiation
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDistance in interface NXmoderator
Parameters:
distance - the distance








setDistanceScalar
public DataNode setDistanceScalar(java.lang.Double distance)
Description copied from interface: NXmoderator
Effective distance as seen by measuring radiation
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setDistanceScalar in interface NXmoderator
Parameters:
distance - the distance








getType
public IDataset getType()
Description copied from interface: NXmoderator

 
Enumeration:

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

 


Specified by:
getType in interface NXmoderator
Returns:
the value.








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXmoderator

 
Enumeration:

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

 


Specified by:
getTypeScalar in interface NXmoderator
Returns:
the value.








setType
public DataNode setType(IDataset type)
Description copied from interface: NXmoderator

 
Enumeration:

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

 


Specified by:
setType in interface NXmoderator
Parameters:
type - the type








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXmoderator

 
Enumeration:

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

 


Specified by:
setTypeScalar in interface NXmoderator
Parameters:
type - the type








getPoison_depth
public IDataset getPoison_depth()
Description copied from interface: NXmoderator

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getPoison_depth in interface NXmoderator
Returns:
the value.








getPoison_depthScalar
public java.lang.Double getPoison_depthScalar()
Description copied from interface: NXmoderator

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getPoison_depthScalar in interface NXmoderator
Returns:
the value.








setPoison_depth
public DataNode setPoison_depth(IDataset poison_depth)
Description copied from interface: NXmoderator

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setPoison_depth in interface NXmoderator
Parameters:
poison_depth - the poison_depth








setPoison_depthScalar
public DataNode setPoison_depthScalar(java.lang.Double poison_depth)
Description copied from interface: NXmoderator

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setPoison_depthScalar in interface NXmoderator
Parameters:
poison_depth - the poison_depth








getCoupled
public IDataset getCoupled()
Description copied from interface: NXmoderator
whether the moderator is coupled
 

 Type: NX_BOOLEAN
 

Specified by:
getCoupled in interface NXmoderator
Returns:
the value.








getCoupledScalar
public java.lang.Boolean getCoupledScalar()
Description copied from interface: NXmoderator
whether the moderator is coupled
 

 Type: NX_BOOLEAN
 

Specified by:
getCoupledScalar in interface NXmoderator
Returns:
the value.








setCoupled
public DataNode setCoupled(IDataset coupled)
Description copied from interface: NXmoderator
whether the moderator is coupled
 

 Type: NX_BOOLEAN
 

Specified by:
setCoupled in interface NXmoderator
Parameters:
coupled - the coupled








setCoupledScalar
public DataNode setCoupledScalar(java.lang.Boolean coupled)
Description copied from interface: NXmoderator
whether the moderator is coupled
 

 Type: NX_BOOLEAN
 

Specified by:
setCoupledScalar in interface NXmoderator
Parameters:
coupled - the coupled








getCoupling_material
public IDataset getCoupling_material()
Description copied from interface: NXmoderator
The material used for coupling. Usually Cd.

Specified by:
getCoupling_material in interface NXmoderator
Returns:
the value.








getCoupling_materialScalar
public java.lang.String getCoupling_materialScalar()
Description copied from interface: NXmoderator
The material used for coupling. Usually Cd.

Specified by:
getCoupling_materialScalar in interface NXmoderator
Returns:
the value.








setCoupling_material
public DataNode setCoupling_material(IDataset coupling_material)
Description copied from interface: NXmoderator
The material used for coupling. Usually Cd.

Specified by:
setCoupling_material in interface NXmoderator
Parameters:
coupling_material - the coupling_material








setCoupling_materialScalar
public DataNode setCoupling_materialScalar(java.lang.String coupling_material)
Description copied from interface: NXmoderator
The material used for coupling. Usually Cd.

Specified by:
setCoupling_materialScalar in interface NXmoderator
Parameters:
coupling_material - the coupling_material








getPoison_material
public IDataset getPoison_material()
Description copied from interface: NXmoderator

 
Enumeration:

 
Gd 
 
Cd 

 


Specified by:
getPoison_material in interface NXmoderator
Returns:
the value.








getPoison_materialScalar
public java.lang.String getPoison_materialScalar()
Description copied from interface: NXmoderator

 
Enumeration:

 
Gd 
 
Cd 

 


Specified by:
getPoison_materialScalar in interface NXmoderator
Returns:
the value.








setPoison_material
public DataNode setPoison_material(IDataset poison_material)
Description copied from interface: NXmoderator

 
Enumeration:

 
Gd 
 
Cd 

 


Specified by:
setPoison_material in interface NXmoderator
Parameters:
poison_material - the poison_material








setPoison_materialScalar
public DataNode setPoison_materialScalar(java.lang.String poison_material)
Description copied from interface: NXmoderator

 
Enumeration:

 
Gd 
 
Cd 

 


Specified by:
setPoison_materialScalar in interface NXmoderator
Parameters:
poison_material - the poison_material








getTemperature
public IDataset getTemperature()
Description copied from interface: NXmoderator
average/nominal moderator temperature
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 

Specified by:
getTemperature in interface NXmoderator
Returns:
the value.








getTemperatureScalar
public java.lang.Double getTemperatureScalar()
Description copied from interface: NXmoderator
average/nominal moderator temperature
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 

Specified by:
getTemperatureScalar in interface NXmoderator
Returns:
the value.








setTemperature
public DataNode setTemperature(IDataset temperature)
Description copied from interface: NXmoderator
average/nominal moderator temperature
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 

Specified by:
setTemperature in interface NXmoderator
Parameters:
temperature - the temperature








setTemperatureScalar
public DataNode setTemperatureScalar(java.lang.Double temperature)
Description copied from interface: NXmoderator
average/nominal moderator temperature
 

 Type: NX_FLOAT
 Units: NX_TEMPERATURE
 

Specified by:
setTemperatureScalar in interface NXmoderator
Parameters:
temperature - the temperature








getTemperature_log
public NXlog getTemperature_log()
Description copied from interface: NXmoderator
log file of moderator temperature

Specified by:
getTemperature_log in interface NXmoderator
Returns:
the value.








setTemperature_log
public void setTemperature_log(NXlog temperature_log)
Description copied from interface: NXmoderator
log file of moderator temperature

Specified by:
setTemperature_log in interface NXmoderator
Parameters:
temperature_log - the temperature_log








getPulse_shape
public NXdata getPulse_shape()
Description copied from interface: NXmoderator
moderator pulse shape

Specified by:
getPulse_shape in interface NXmoderator
Returns:
the value.








setPulse_shape
public void setPulse_shape(NXdata pulse_shape)
Description copied from interface: NXmoderator
moderator pulse shape

Specified by:
setPulse_shape in interface NXmoderator
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