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



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













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




public class NXcollimatorImpl
extends NXobjectImpl
implements NXcollimator
A beamline collimator.

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.NXcollimator
NX_ABSORBING_MATERIAL, NX_BLADE_SPACING, NX_BLADE_THICKNESS, NX_DIVERGENCE_X, NX_DIVERGENCE_Y, NX_FREQUENCY, NX_SOLLER_ANGLE, NX_TRANSMITTING_MATERIAL, NX_TYPE





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








Constructor Summary

Constructors 

Constructor and Description


NXcollimatorImpl() 


NXcollimatorImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getAbsorbing_material()
name of absorbing material



java.lang.String
getAbsorbing_materialScalar()
name of absorbing material



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



IDataset
getBlade_spacing()
blade spacing



java.lang.Double
getBlade_spacingScalar()
blade spacing



IDataset
getBlade_thickness()
blade thickness



java.lang.Double
getBlade_thicknessScalar()
blade thickness



IDataset
getDivergence_x()
divergence of collimator in local x direction



java.lang.Double
getDivergence_xScalar()
divergence of collimator in local x direction



IDataset
getDivergence_y()
divergence of collimator in local y direction



java.lang.Double
getDivergence_yScalar()
divergence of collimator in local y direction



NXlog
getFrequency_log()
Log of frequency



IDataset
getFrequency()
Frequency of oscillating collimator



java.lang.Double
getFrequencyScalar()
Frequency of oscillating collimator



NXgeometry
getGeometry()
position, shape and size



NXgeometry
getGeometry(java.lang.String name)
Get a NXgeometry node by name:
 
 
 position, shape and size
 



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
getSoller_angle()
Angular divergence of Soller collimator



java.lang.Double
getSoller_angleScalar()
Angular divergence of Soller collimator



IDataset
getTransmitting_material()
name of transmitting material



java.lang.String
getTransmitting_materialScalar()
name of transmitting material



IDataset
getType()


java.lang.String
getTypeScalar()


DataNode
setAbsorbing_material(IDataset absorbing_material)
name of absorbing material



DataNode
setAbsorbing_materialScalar(java.lang.String absorbing_material)
name of absorbing material



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



DataNode
setBlade_spacing(IDataset blade_spacing)
blade spacing



DataNode
setBlade_spacingScalar(java.lang.Double blade_spacing)
blade spacing



DataNode
setBlade_thickness(IDataset blade_thickness)
blade thickness



DataNode
setBlade_thicknessScalar(java.lang.Double blade_thickness)
blade thickness



DataNode
setDivergence_x(IDataset divergence_x)
divergence of collimator in local x direction



DataNode
setDivergence_xScalar(java.lang.Double divergence_x)
divergence of collimator in local x direction



DataNode
setDivergence_y(IDataset divergence_y)
divergence of collimator in local y direction



DataNode
setDivergence_yScalar(java.lang.Double divergence_y)
divergence of collimator in local y direction



void
setFrequency_log(NXlog frequency_log)
Log of frequency



DataNode
setFrequency(IDataset frequency)
Frequency of oscillating collimator



DataNode
setFrequencyScalar(java.lang.Double frequency)
Frequency of oscillating collimator



void
setGeometry(NXgeometry geometry)
position, shape and size



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



DataNode
setSoller_angle(IDataset soller_angle)
Angular divergence of Soller collimator



DataNode
setSoller_angleScalar(java.lang.Double soller_angle)
Angular divergence of Soller collimator



DataNode
setTransmitting_material(IDataset transmitting_material)
name of transmitting material



DataNode
setTransmitting_materialScalar(java.lang.String transmitting_material)
name of transmitting material



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





NXcollimatorImpl
public NXcollimatorImpl()







NXcollimatorImpl
public NXcollimatorImpl(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: NXcollimator
position, shape and size

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








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXcollimator
position, shape and size

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








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

 

 position, shape and size
 

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

 

 position, shape and size
 

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

 

 position, shape and size
 

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

 

 position, shape and size
 

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








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

 
Enumeration:

 
Soller 
 
radial 
 
oscillating 
 
honeycomb 

 


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








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

 
Enumeration:

 
Soller 
 
radial 
 
oscillating 
 
honeycomb 

 


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








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

 
Enumeration:

 
Soller 
 
radial 
 
oscillating 
 
honeycomb 

 


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








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

 
Enumeration:

 
Soller 
 
radial 
 
oscillating 
 
honeycomb 

 


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








getSoller_angle
public IDataset getSoller_angle()
Description copied from interface: NXcollimator
Angular divergence of Soller collimator
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getSoller_angle in interface NXcollimator
Returns:
the value.








getSoller_angleScalar
public java.lang.Double getSoller_angleScalar()
Description copied from interface: NXcollimator
Angular divergence of Soller collimator
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getSoller_angleScalar in interface NXcollimator
Returns:
the value.








setSoller_angle
public DataNode setSoller_angle(IDataset soller_angle)
Description copied from interface: NXcollimator
Angular divergence of Soller collimator
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setSoller_angle in interface NXcollimator
Parameters:
soller_angle - the soller_angle








setSoller_angleScalar
public DataNode setSoller_angleScalar(java.lang.Double soller_angle)
Description copied from interface: NXcollimator
Angular divergence of Soller collimator
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setSoller_angleScalar in interface NXcollimator
Parameters:
soller_angle - the soller_angle








getDivergence_x
public IDataset getDivergence_x()
Description copied from interface: NXcollimator
divergence of collimator in local x direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_x in interface NXcollimator
Returns:
the value.








getDivergence_xScalar
public java.lang.Double getDivergence_xScalar()
Description copied from interface: NXcollimator
divergence of collimator in local x direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_xScalar in interface NXcollimator
Returns:
the value.








setDivergence_x
public DataNode setDivergence_x(IDataset divergence_x)
Description copied from interface: NXcollimator
divergence of collimator in local x direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_x in interface NXcollimator
Parameters:
divergence_x - the divergence_x








setDivergence_xScalar
public DataNode setDivergence_xScalar(java.lang.Double divergence_x)
Description copied from interface: NXcollimator
divergence of collimator in local x direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_xScalar in interface NXcollimator
Parameters:
divergence_x - the divergence_x








getDivergence_y
public IDataset getDivergence_y()
Description copied from interface: NXcollimator
divergence of collimator in local y direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_y in interface NXcollimator
Returns:
the value.








getDivergence_yScalar
public java.lang.Double getDivergence_yScalar()
Description copied from interface: NXcollimator
divergence of collimator in local y direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getDivergence_yScalar in interface NXcollimator
Returns:
the value.








setDivergence_y
public DataNode setDivergence_y(IDataset divergence_y)
Description copied from interface: NXcollimator
divergence of collimator in local y direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_y in interface NXcollimator
Parameters:
divergence_y - the divergence_y








setDivergence_yScalar
public DataNode setDivergence_yScalar(java.lang.Double divergence_y)
Description copied from interface: NXcollimator
divergence of collimator in local y direction
 

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setDivergence_yScalar in interface NXcollimator
Parameters:
divergence_y - the divergence_y








getFrequency
public IDataset getFrequency()
Description copied from interface: NXcollimator
Frequency of oscillating collimator
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Specified by:
getFrequency in interface NXcollimator
Returns:
the value.








getFrequencyScalar
public java.lang.Double getFrequencyScalar()
Description copied from interface: NXcollimator
Frequency of oscillating collimator
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Specified by:
getFrequencyScalar in interface NXcollimator
Returns:
the value.








setFrequency
public DataNode setFrequency(IDataset frequency)
Description copied from interface: NXcollimator
Frequency of oscillating collimator
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Specified by:
setFrequency in interface NXcollimator
Parameters:
frequency - the frequency








setFrequencyScalar
public DataNode setFrequencyScalar(java.lang.Double frequency)
Description copied from interface: NXcollimator
Frequency of oscillating collimator
 

 Type: NX_FLOAT
 Units: NX_FREQUENCY
 

Specified by:
setFrequencyScalar in interface NXcollimator
Parameters:
frequency - the frequency








getFrequency_log
public NXlog getFrequency_log()
Description copied from interface: NXcollimator
Log of frequency

Specified by:
getFrequency_log in interface NXcollimator
Returns:
the value.








setFrequency_log
public void setFrequency_log(NXlog frequency_log)
Description copied from interface: NXcollimator
Log of frequency

Specified by:
setFrequency_log in interface NXcollimator
Parameters:
frequency_log - the frequency_log








getBlade_thickness
public IDataset getBlade_thickness()
Description copied from interface: NXcollimator
blade thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getBlade_thickness in interface NXcollimator
Returns:
the value.








getBlade_thicknessScalar
public java.lang.Double getBlade_thicknessScalar()
Description copied from interface: NXcollimator
blade thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getBlade_thicknessScalar in interface NXcollimator
Returns:
the value.








setBlade_thickness
public DataNode setBlade_thickness(IDataset blade_thickness)
Description copied from interface: NXcollimator
blade thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setBlade_thickness in interface NXcollimator
Parameters:
blade_thickness - the blade_thickness








setBlade_thicknessScalar
public DataNode setBlade_thicknessScalar(java.lang.Double blade_thickness)
Description copied from interface: NXcollimator
blade thickness
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setBlade_thicknessScalar in interface NXcollimator
Parameters:
blade_thickness - the blade_thickness








getBlade_spacing
public IDataset getBlade_spacing()
Description copied from interface: NXcollimator
blade spacing
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getBlade_spacing in interface NXcollimator
Returns:
the value.








getBlade_spacingScalar
public java.lang.Double getBlade_spacingScalar()
Description copied from interface: NXcollimator
blade spacing
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getBlade_spacingScalar in interface NXcollimator
Returns:
the value.








setBlade_spacing
public DataNode setBlade_spacing(IDataset blade_spacing)
Description copied from interface: NXcollimator
blade spacing
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setBlade_spacing in interface NXcollimator
Parameters:
blade_spacing - the blade_spacing








setBlade_spacingScalar
public DataNode setBlade_spacingScalar(java.lang.Double blade_spacing)
Description copied from interface: NXcollimator
blade spacing
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setBlade_spacingScalar in interface NXcollimator
Parameters:
blade_spacing - the blade_spacing








getAbsorbing_material
public IDataset getAbsorbing_material()
Description copied from interface: NXcollimator
name of absorbing material

Specified by:
getAbsorbing_material in interface NXcollimator
Returns:
the value.








getAbsorbing_materialScalar
public java.lang.String getAbsorbing_materialScalar()
Description copied from interface: NXcollimator
name of absorbing material

Specified by:
getAbsorbing_materialScalar in interface NXcollimator
Returns:
the value.








setAbsorbing_material
public DataNode setAbsorbing_material(IDataset absorbing_material)
Description copied from interface: NXcollimator
name of absorbing material

Specified by:
setAbsorbing_material in interface NXcollimator
Parameters:
absorbing_material - the absorbing_material








setAbsorbing_materialScalar
public DataNode setAbsorbing_materialScalar(java.lang.String absorbing_material)
Description copied from interface: NXcollimator
name of absorbing material

Specified by:
setAbsorbing_materialScalar in interface NXcollimator
Parameters:
absorbing_material - the absorbing_material








getTransmitting_material
public IDataset getTransmitting_material()
Description copied from interface: NXcollimator
name of transmitting material

Specified by:
getTransmitting_material in interface NXcollimator
Returns:
the value.








getTransmitting_materialScalar
public java.lang.String getTransmitting_materialScalar()
Description copied from interface: NXcollimator
name of transmitting material

Specified by:
getTransmitting_materialScalar in interface NXcollimator
Returns:
the value.








setTransmitting_material
public DataNode setTransmitting_material(IDataset transmitting_material)
Description copied from interface: NXcollimator
name of transmitting material

Specified by:
setTransmitting_material in interface NXcollimator
Parameters:
transmitting_material - the transmitting_material








setTransmitting_materialScalar
public DataNode setTransmitting_materialScalar(java.lang.String transmitting_material)
Description copied from interface: NXcollimator
name of transmitting material

Specified by:
setTransmitting_materialScalar in interface NXcollimator
Parameters:
transmitting_material - the transmitting_material














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