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






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


All Known Implementing Classes:
NXspin_rotatorImpl




public interface NXspin_rotator
extends NXobject
definition for a spin rotator.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_BEAMLINE_DISTANCE 


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_SET_BFIELD_CURRENT 


static java.lang.String
NX_SET_EFIELD_VOLTAGE 






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


IDataset
getBeamline_distance()
define position of beamline element relative to production target



java.lang.Double
getBeamline_distanceScalar()
define position of beamline element relative to production target



IDataset
getDescription()
extended description of the spin rotator.



java.lang.String
getDescriptionScalar()
extended description of the spin rotator.



NXlog
getRead_Bfield_current()
current read from magnet supply.



NXlog
getRead_Bfield_voltage()
voltage read from magnet supply.



NXlog
getRead_Efield_current()
current read from HT supply.



NXlog
getRead_Efield_voltage()
voltage read from HT supply.



IDataset
getSet_Bfield_current()
current set on magnet supply.



java.lang.Double
getSet_Bfield_currentScalar()
current set on magnet supply.



IDataset
getSet_Efield_voltage()
current set on HT supply.



java.lang.Double
getSet_Efield_voltageScalar()
current set on HT supply.



DataNode
setBeamline_distance(IDataset beamline_distance)
define position of beamline element relative to production target



DataNode
setBeamline_distanceScalar(java.lang.Double beamline_distance)
define position of beamline element relative to production target



DataNode
setDescription(IDataset description)
extended description of the spin rotator.



DataNode
setDescriptionScalar(java.lang.String description)
extended description of the spin rotator.



void
setRead_Bfield_current(NXlog read_Bfield_current)
current read from magnet supply.



void
setRead_Bfield_voltage(NXlog read_Bfield_voltage)
voltage read from magnet supply.



void
setRead_Efield_current(NXlog read_Efield_current)
current read from HT supply.



void
setRead_Efield_voltage(NXlog read_Efield_voltage)
voltage read from HT supply.



DataNode
setSet_Bfield_current(IDataset set_Bfield_current)
current set on magnet supply.



DataNode
setSet_Bfield_currentScalar(java.lang.Double set_Bfield_current)
current set on magnet supply.



DataNode
setSet_Efield_voltage(IDataset set_Efield_voltage)
current set on HT supply.



DataNode
setSet_Efield_voltageScalar(java.lang.Double set_Efield_voltage)
current set on HT supply.







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_DESCRIPTION
static final java.lang.String NX_DESCRIPTION

See Also:
Constant Field Values








NX_BEAMLINE_DISTANCE
static final java.lang.String NX_BEAMLINE_DISTANCE

See Also:
Constant Field Values








NX_SET_BFIELD_CURRENT
static final java.lang.String NX_SET_BFIELD_CURRENT

See Also:
Constant Field Values








NX_SET_EFIELD_VOLTAGE
static final java.lang.String NX_SET_EFIELD_VOLTAGE

See Also:
Constant Field Values










Method Detail





getDescription
IDataset getDescription()
extended description of the spin rotator.
 

 Type: NX_CHAR
 

Returns:
the value.








setDescription
DataNode setDescription(IDataset description)
extended description of the spin rotator.
 

 Type: NX_CHAR
 

Parameters:
description - the description








getDescriptionScalar
java.lang.String getDescriptionScalar()
extended description of the spin rotator.
 

 Type: NX_CHAR
 

Returns:
the value.








setDescriptionScalar
DataNode setDescriptionScalar(java.lang.String description)
extended description of the spin rotator.
 

 Type: NX_CHAR
 

Parameters:
description - the description








getBeamline_distance
IDataset getBeamline_distance()
define position of beamline element relative to production target
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setBeamline_distance
DataNode setBeamline_distance(IDataset beamline_distance)
define position of beamline element relative to production target
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
beamline_distance - the beamline_distance








getBeamline_distanceScalar
java.lang.Double getBeamline_distanceScalar()
define position of beamline element relative to production target
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Returns:
the value.








setBeamline_distanceScalar
DataNode setBeamline_distanceScalar(java.lang.Double beamline_distance)
define position of beamline element relative to production target
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Parameters:
beamline_distance - the beamline_distance








getSet_Bfield_current
IDataset getSet_Bfield_current()
current set on magnet supply.
 

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Returns:
the value.








setSet_Bfield_current
DataNode setSet_Bfield_current(IDataset set_Bfield_current)
current set on magnet supply.
 

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Parameters:
set_Bfield_current - the set_Bfield_current








getSet_Bfield_currentScalar
java.lang.Double getSet_Bfield_currentScalar()
current set on magnet supply.
 

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Returns:
the value.








setSet_Bfield_currentScalar
DataNode setSet_Bfield_currentScalar(java.lang.Double set_Bfield_current)
current set on magnet supply.
 

 Type: NX_FLOAT
 Units: NX_CURRENT
 

Parameters:
set_Bfield_current - the set_Bfield_current








getRead_Bfield_current
NXlog getRead_Bfield_current()
current read from magnet supply.

Returns:
the value.








setRead_Bfield_current
void setRead_Bfield_current(NXlog read_Bfield_current)
current read from magnet supply.

Parameters:
read_Bfield_current - the read_Bfield_current








getRead_Bfield_voltage
NXlog getRead_Bfield_voltage()
voltage read from magnet supply.

Returns:
the value.








setRead_Bfield_voltage
void setRead_Bfield_voltage(NXlog read_Bfield_voltage)
voltage read from magnet supply.

Parameters:
read_Bfield_voltage - the read_Bfield_voltage








getSet_Efield_voltage
IDataset getSet_Efield_voltage()
current set on HT supply.
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Returns:
the value.








setSet_Efield_voltage
DataNode setSet_Efield_voltage(IDataset set_Efield_voltage)
current set on HT supply.
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Parameters:
set_Efield_voltage - the set_Efield_voltage








getSet_Efield_voltageScalar
java.lang.Double getSet_Efield_voltageScalar()
current set on HT supply.
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Returns:
the value.








setSet_Efield_voltageScalar
DataNode setSet_Efield_voltageScalar(java.lang.Double set_Efield_voltage)
current set on HT supply.
 

 Type: NX_FLOAT
 Units: NX_VOLTAGE
 

Parameters:
set_Efield_voltage - the set_Efield_voltage








getRead_Efield_current
NXlog getRead_Efield_current()
current read from HT supply.

Returns:
the value.








setRead_Efield_current
void setRead_Efield_current(NXlog read_Efield_current)
current read from HT supply.

Parameters:
read_Efield_current - the read_Efield_current








getRead_Efield_voltage
NXlog getRead_Efield_voltage()
voltage read from HT supply.

Returns:
the value.








setRead_Efield_voltage
void setRead_Efield_voltage(NXlog read_Efield_voltage)
voltage read from HT supply.

Parameters:
read_Efield_voltage - the read_Efield_voltage














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