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



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













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




public class NXcapillaryImpl
extends NXobjectImpl
implements NXcapillary
A capillary lens to focus the X-ray beam.
 Based on information provided by Gerd Wellenreuther (DESY).

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.NXcapillary
NX_ACCEPTING_APERTURE, NX_FOCAL_SIZE, NX_MANUFACTURER, NX_MAXIMUM_INCIDENT_ANGLE, NX_TYPE, NX_WORKING_DISTANCE





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








Constructor Summary

Constructors 

Constructor and Description


NXcapillaryImpl() 


NXcapillaryImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


IDataset
getAccepting_aperture()

 Type: NX_FLOAT
 Units: NX_ANGLE



java.lang.Double
getAccepting_apertureScalar()

 Type: NX_FLOAT
 Units: NX_ANGLE



IDataset
getFocal_size()
The focal size in FWHM



java.lang.Double
getFocal_sizeScalar()
The focal size in FWHM



NXdata
getGain()
The gain of the capillary as a function of energy



IDataset
getManufacturer()
The manufacturer of the capillary.



java.lang.String
getManufacturerScalar()
The manufacturer of the capillary.



IDataset
getMaximum_incident_angle()

 Type: NX_FLOAT
 Units: NX_ANGLE



java.lang.Double
getMaximum_incident_angleScalar()

 Type: NX_FLOAT
 Units: NX_ANGLE



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.



NXdata
getTransmission()
The transmission of the capillary as a function of energy



IDataset
getType()
Type of the capillary



java.lang.String
getTypeScalar()
Type of the capillary



IDataset
getWorking_distance()

 Type: NX_FLOAT
 Units: NX_LENGTH



java.lang.Double
getWorking_distanceScalar()

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setAccepting_aperture(IDataset accepting_aperture)

 Type: NX_FLOAT
 Units: NX_ANGLE



DataNode
setAccepting_apertureScalar(java.lang.Double accepting_aperture)

 Type: NX_FLOAT
 Units: NX_ANGLE



DataNode
setFocal_size(IDataset focal_size)
The focal size in FWHM



DataNode
setFocal_sizeScalar(java.lang.Double focal_size)
The focal size in FWHM



void
setGain(NXdata gain)
The gain of the capillary as a function of energy



DataNode
setManufacturer(IDataset manufacturer)
The manufacturer of the capillary.



DataNode
setManufacturerScalar(java.lang.String manufacturer)
The manufacturer of the capillary.



DataNode
setMaximum_incident_angle(IDataset maximum_incident_angle)

 Type: NX_FLOAT
 Units: NX_ANGLE



DataNode
setMaximum_incident_angleScalar(java.lang.Double maximum_incident_angle)

 Type: NX_FLOAT
 Units: NX_ANGLE



void
setTransmission(NXdata transmission)
The transmission of the capillary as a function of energy



DataNode
setType(IDataset type)
Type of the capillary



DataNode
setTypeScalar(java.lang.String type)
Type of the capillary



DataNode
setWorking_distance(IDataset working_distance)

 Type: NX_FLOAT
 Units: NX_LENGTH



DataNode
setWorking_distanceScalar(java.lang.Double working_distance)

 Type: NX_FLOAT
 Units: NX_LENGTH







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





NXcapillaryImpl
public NXcapillaryImpl()







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








getType
public IDataset getType()
Description copied from interface: NXcapillary
Type of the capillary
 

 Type: NX_CHAR
 
Enumeration:

 
single_bounce 
 
polycapillary 
 
conical_capillary 

 


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








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXcapillary
Type of the capillary
 

 Type: NX_CHAR
 
Enumeration:

 
single_bounce 
 
polycapillary 
 
conical_capillary 

 


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








setType
public DataNode setType(IDataset type)
Description copied from interface: NXcapillary
Type of the capillary
 

 Type: NX_CHAR
 
Enumeration:

 
single_bounce 
 
polycapillary 
 
conical_capillary 

 


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








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXcapillary
Type of the capillary
 

 Type: NX_CHAR
 
Enumeration:

 
single_bounce 
 
polycapillary 
 
conical_capillary 

 


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








getManufacturer
public IDataset getManufacturer()
Description copied from interface: NXcapillary
The manufacturer of the capillary. This is actually important as
 it may have an impact on performance.
 

 Type: NX_CHAR
 

Specified by:
getManufacturer in interface NXcapillary
Returns:
the value.








getManufacturerScalar
public java.lang.String getManufacturerScalar()
Description copied from interface: NXcapillary
The manufacturer of the capillary. This is actually important as
 it may have an impact on performance.
 

 Type: NX_CHAR
 

Specified by:
getManufacturerScalar in interface NXcapillary
Returns:
the value.








setManufacturer
public DataNode setManufacturer(IDataset manufacturer)
Description copied from interface: NXcapillary
The manufacturer of the capillary. This is actually important as
 it may have an impact on performance.
 

 Type: NX_CHAR
 

Specified by:
setManufacturer in interface NXcapillary
Parameters:
manufacturer - the manufacturer








setManufacturerScalar
public DataNode setManufacturerScalar(java.lang.String manufacturer)
Description copied from interface: NXcapillary
The manufacturer of the capillary. This is actually important as
 it may have an impact on performance.
 

 Type: NX_CHAR
 

Specified by:
setManufacturerScalar in interface NXcapillary
Parameters:
manufacturer - the manufacturer








getMaximum_incident_angle
public IDataset getMaximum_incident_angle()
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getMaximum_incident_angle in interface NXcapillary
Returns:
the value.








getMaximum_incident_angleScalar
public java.lang.Double getMaximum_incident_angleScalar()
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getMaximum_incident_angleScalar in interface NXcapillary
Returns:
the value.








setMaximum_incident_angle
public DataNode setMaximum_incident_angle(IDataset maximum_incident_angle)
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setMaximum_incident_angle in interface NXcapillary
Parameters:
maximum_incident_angle - the maximum_incident_angle








setMaximum_incident_angleScalar
public DataNode setMaximum_incident_angleScalar(java.lang.Double maximum_incident_angle)
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setMaximum_incident_angleScalar in interface NXcapillary
Parameters:
maximum_incident_angle - the maximum_incident_angle








getAccepting_aperture
public IDataset getAccepting_aperture()
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getAccepting_aperture in interface NXcapillary
Returns:
the value.








getAccepting_apertureScalar
public java.lang.Double getAccepting_apertureScalar()
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
getAccepting_apertureScalar in interface NXcapillary
Returns:
the value.








setAccepting_aperture
public DataNode setAccepting_aperture(IDataset accepting_aperture)
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setAccepting_aperture in interface NXcapillary
Parameters:
accepting_aperture - the accepting_aperture








setAccepting_apertureScalar
public DataNode setAccepting_apertureScalar(java.lang.Double accepting_aperture)
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_ANGLE
 

Specified by:
setAccepting_apertureScalar in interface NXcapillary
Parameters:
accepting_aperture - the accepting_aperture








getGain
public NXdata getGain()
Description copied from interface: NXcapillary
The gain of the capillary as a function of energy

Specified by:
getGain in interface NXcapillary
Returns:
the value.








setGain
public void setGain(NXdata gain)
Description copied from interface: NXcapillary
The gain of the capillary as a function of energy

Specified by:
setGain in interface NXcapillary
Parameters:
gain - the gain








getTransmission
public NXdata getTransmission()
Description copied from interface: NXcapillary
The transmission of the capillary as a function of energy

Specified by:
getTransmission in interface NXcapillary
Returns:
the value.








setTransmission
public void setTransmission(NXdata transmission)
Description copied from interface: NXcapillary
The transmission of the capillary as a function of energy

Specified by:
setTransmission in interface NXcapillary
Parameters:
transmission - the transmission








getWorking_distance
public IDataset getWorking_distance()
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getWorking_distance in interface NXcapillary
Returns:
the value.








getWorking_distanceScalar
public java.lang.Double getWorking_distanceScalar()
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getWorking_distanceScalar in interface NXcapillary
Returns:
the value.








setWorking_distance
public DataNode setWorking_distance(IDataset working_distance)
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setWorking_distance in interface NXcapillary
Parameters:
working_distance - the working_distance








setWorking_distanceScalar
public DataNode setWorking_distanceScalar(java.lang.Double working_distance)
Description copied from interface: NXcapillary

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setWorking_distanceScalar in interface NXcapillary
Parameters:
working_distance - the working_distance








getFocal_size
public IDataset getFocal_size()
Description copied from interface: NXcapillary
The focal size in FWHM
 

 Type: NX_FLOAT
 

Specified by:
getFocal_size in interface NXcapillary
Returns:
the value.








getFocal_sizeScalar
public java.lang.Double getFocal_sizeScalar()
Description copied from interface: NXcapillary
The focal size in FWHM
 

 Type: NX_FLOAT
 

Specified by:
getFocal_sizeScalar in interface NXcapillary
Returns:
the value.








setFocal_size
public DataNode setFocal_size(IDataset focal_size)
Description copied from interface: NXcapillary
The focal size in FWHM
 

 Type: NX_FLOAT
 

Specified by:
setFocal_size in interface NXcapillary
Parameters:
focal_size - the focal_size








setFocal_sizeScalar
public DataNode setFocal_sizeScalar(java.lang.Double focal_size)
Description copied from interface: NXcapillary
The focal size in FWHM
 

 Type: NX_FLOAT
 

Specified by:
setFocal_sizeScalar in interface NXcapillary
Parameters:
focal_size - the focal_size














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