generated.docs.javadoc.org.eclipse.dawnsci.nexus.impl.NXspin_rotatorImpl.html Maven / Gradle / Ivy
NXspin_rotatorImpl (h5jan API)
org.eclipse.dawnsci.nexus.impl
Class NXspin_rotatorImpl
- 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.NXspin_rotatorImpl
-
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXobject, NXspin_rotator
public class NXspin_rotatorImpl
extends NXobjectImpl
implements NXspin_rotator
definition for a spin rotator.
- 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.NXspin_rotator
NX_BEAMLINE_DISTANCE, NX_DESCRIPTION, NX_SET_BFIELD_CURRENT, NX_SET_EFIELD_VOLTAGE
-
Constructor Summary
Constructors
Constructor and Description
NXspin_rotatorImpl()
NXspin_rotatorImpl(long oid)
-
Method Summary
All Methods Instance Methods Concrete 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.
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.
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 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
-
-
Field Detail
-
PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES
-
Constructor Detail
-
NXspin_rotatorImpl
public NXspin_rotatorImpl()
-
NXspin_rotatorImpl
public NXspin_rotatorImpl(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
-
getDescription
public IDataset getDescription()
Description copied from interface: NXspin_rotator
extended description of the spin rotator.
Type: NX_CHAR
- Specified by:
getDescription
in interface NXspin_rotator
- Returns:
- the value.
-
getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXspin_rotator
extended description of the spin rotator.
Type: NX_CHAR
- Specified by:
getDescriptionScalar
in interface NXspin_rotator
- Returns:
- the value.
-
setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXspin_rotator
extended description of the spin rotator.
Type: NX_CHAR
- Specified by:
setDescription
in interface NXspin_rotator
- Parameters:
description
- the description
-
setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXspin_rotator
extended description of the spin rotator.
Type: NX_CHAR
- Specified by:
setDescriptionScalar
in interface NXspin_rotator
- Parameters:
description
- the description
-
getBeamline_distance
public IDataset getBeamline_distance()
Description copied from interface: NXspin_rotator
define position of beamline element relative to production target
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getBeamline_distance
in interface NXspin_rotator
- Returns:
- the value.
-
getBeamline_distanceScalar
public java.lang.Double getBeamline_distanceScalar()
Description copied from interface: NXspin_rotator
define position of beamline element relative to production target
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
getBeamline_distanceScalar
in interface NXspin_rotator
- Returns:
- the value.
-
setBeamline_distance
public DataNode setBeamline_distance(IDataset beamline_distance)
Description copied from interface: NXspin_rotator
define position of beamline element relative to production target
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setBeamline_distance
in interface NXspin_rotator
- Parameters:
beamline_distance
- the beamline_distance
-
setBeamline_distanceScalar
public DataNode setBeamline_distanceScalar(java.lang.Double beamline_distance)
Description copied from interface: NXspin_rotator
define position of beamline element relative to production target
Type: NX_FLOAT
Units: NX_LENGTH
- Specified by:
setBeamline_distanceScalar
in interface NXspin_rotator
- Parameters:
beamline_distance
- the beamline_distance
-
getSet_Bfield_current
public IDataset getSet_Bfield_current()
Description copied from interface: NXspin_rotator
current set on magnet supply.
Type: NX_FLOAT
Units: NX_CURRENT
- Specified by:
getSet_Bfield_current
in interface NXspin_rotator
- Returns:
- the value.
-
getSet_Bfield_currentScalar
public java.lang.Double getSet_Bfield_currentScalar()
Description copied from interface: NXspin_rotator
current set on magnet supply.
Type: NX_FLOAT
Units: NX_CURRENT
- Specified by:
getSet_Bfield_currentScalar
in interface NXspin_rotator
- Returns:
- the value.
-
setSet_Bfield_current
public DataNode setSet_Bfield_current(IDataset set_Bfield_current)
Description copied from interface: NXspin_rotator
current set on magnet supply.
Type: NX_FLOAT
Units: NX_CURRENT
- Specified by:
setSet_Bfield_current
in interface NXspin_rotator
- Parameters:
set_Bfield_current
- the set_Bfield_current
-
setSet_Bfield_currentScalar
public DataNode setSet_Bfield_currentScalar(java.lang.Double set_Bfield_current)
Description copied from interface: NXspin_rotator
current set on magnet supply.
Type: NX_FLOAT
Units: NX_CURRENT
- Specified by:
setSet_Bfield_currentScalar
in interface NXspin_rotator
- Parameters:
set_Bfield_current
- the set_Bfield_current
-
getRead_Bfield_current
public NXlog getRead_Bfield_current()
Description copied from interface: NXspin_rotator
current read from magnet supply.
- Specified by:
getRead_Bfield_current
in interface NXspin_rotator
- Returns:
- the value.
-
setRead_Bfield_current
public void setRead_Bfield_current(NXlog read_Bfield_current)
Description copied from interface: NXspin_rotator
current read from magnet supply.
- Specified by:
setRead_Bfield_current
in interface NXspin_rotator
- Parameters:
read_Bfield_current
- the read_Bfield_current
-
getRead_Bfield_voltage
public NXlog getRead_Bfield_voltage()
Description copied from interface: NXspin_rotator
voltage read from magnet supply.
- Specified by:
getRead_Bfield_voltage
in interface NXspin_rotator
- Returns:
- the value.
-
setRead_Bfield_voltage
public void setRead_Bfield_voltage(NXlog read_Bfield_voltage)
Description copied from interface: NXspin_rotator
voltage read from magnet supply.
- Specified by:
setRead_Bfield_voltage
in interface NXspin_rotator
- Parameters:
read_Bfield_voltage
- the read_Bfield_voltage
-
getSet_Efield_voltage
public IDataset getSet_Efield_voltage()
Description copied from interface: NXspin_rotator
current set on HT supply.
Type: NX_FLOAT
Units: NX_VOLTAGE
- Specified by:
getSet_Efield_voltage
in interface NXspin_rotator
- Returns:
- the value.
-
getSet_Efield_voltageScalar
public java.lang.Double getSet_Efield_voltageScalar()
Description copied from interface: NXspin_rotator
current set on HT supply.
Type: NX_FLOAT
Units: NX_VOLTAGE
- Specified by:
getSet_Efield_voltageScalar
in interface NXspin_rotator
- Returns:
- the value.
-
setSet_Efield_voltage
public DataNode setSet_Efield_voltage(IDataset set_Efield_voltage)
Description copied from interface: NXspin_rotator
current set on HT supply.
Type: NX_FLOAT
Units: NX_VOLTAGE
- Specified by:
setSet_Efield_voltage
in interface NXspin_rotator
- Parameters:
set_Efield_voltage
- the set_Efield_voltage
-
setSet_Efield_voltageScalar
public DataNode setSet_Efield_voltageScalar(java.lang.Double set_Efield_voltage)
Description copied from interface: NXspin_rotator
current set on HT supply.
Type: NX_FLOAT
Units: NX_VOLTAGE
- Specified by:
setSet_Efield_voltageScalar
in interface NXspin_rotator
- Parameters:
set_Efield_voltage
- the set_Efield_voltage
-
getRead_Efield_current
public NXlog getRead_Efield_current()
Description copied from interface: NXspin_rotator
current read from HT supply.
- Specified by:
getRead_Efield_current
in interface NXspin_rotator
- Returns:
- the value.
-
setRead_Efield_current
public void setRead_Efield_current(NXlog read_Efield_current)
Description copied from interface: NXspin_rotator
current read from HT supply.
- Specified by:
setRead_Efield_current
in interface NXspin_rotator
- Parameters:
read_Efield_current
- the read_Efield_current
-
getRead_Efield_voltage
public NXlog getRead_Efield_voltage()
Description copied from interface: NXspin_rotator
voltage read from HT supply.
- Specified by:
getRead_Efield_voltage
in interface NXspin_rotator
- Returns:
- the value.
-
setRead_Efield_voltage
public void setRead_Efield_voltage(NXlog read_Efield_voltage)
Description copied from interface: NXspin_rotator
voltage read from HT supply.
- Specified by:
setRead_Efield_voltage
in interface NXspin_rotator
- Parameters:
read_Efield_voltage
- the read_Efield_voltage