generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXelectrostatic_kicker.html Maven / Gradle / Ivy
NXelectrostatic_kicker (h5jan API)
org.eclipse.dawnsci.nexus
Interface NXelectrostatic_kicker
-
-
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_CURRENT
static java.lang.String
NX_SET_VOLTAGE
static java.lang.String
NX_TIMING
static java.lang.String
NX_TIMING_ATTRIBUTE_DESCRIPTION
-
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 kicker.
java.lang.String
getDescriptionScalar()
extended description of the kicker.
NXlog
getRead_current()
current read from supply.
NXlog
getRead_voltage()
voltage read from supply.
IDataset
getSet_current()
current set on supply.
java.lang.Double
getSet_currentScalar()
current set on supply.
IDataset
getSet_voltage()
volage set on supply.
java.lang.Double
getSet_voltageScalar()
volage set on supply.
IDataset
getTiming()
kicker timing as defined by ``description`` attribute
java.lang.String
getTimingAttributeDescription()
java.lang.Double
getTimingScalar()
kicker timing as defined by ``description`` attribute
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 kicker.
DataNode
setDescriptionScalar(java.lang.String description)
extended description of the kicker.
void
setRead_current(NXlog read_current)
current read from supply.
void
setRead_voltage(NXlog read_voltage)
voltage read from supply.
DataNode
setSet_current(IDataset set_current)
current set on supply.
DataNode
setSet_currentScalar(java.lang.Double set_current)
current set on supply.
DataNode
setSet_voltage(IDataset set_voltage)
volage set on supply.
DataNode
setSet_voltageScalar(java.lang.Double set_voltage)
volage set on supply.
DataNode
setTiming(IDataset timing)
kicker timing as defined by ``description`` attribute
void
setTimingAttributeDescription(java.lang.String description)
DataNode
setTimingScalar(java.lang.Double timing)
kicker timing as defined by ``description`` attribute
-
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
-
-
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_TIMING
static final java.lang.String NX_TIMING
- See Also:
- Constant Field Values
-
NX_TIMING_ATTRIBUTE_DESCRIPTION
static final java.lang.String NX_TIMING_ATTRIBUTE_DESCRIPTION
- See Also:
- Constant Field Values
-
NX_SET_CURRENT
static final java.lang.String NX_SET_CURRENT
- See Also:
- Constant Field Values
-
NX_SET_VOLTAGE
static final java.lang.String NX_SET_VOLTAGE
- See Also:
- Constant Field Values
-
Method Detail
-
getDescription
IDataset getDescription()
extended description of the kicker.
Type: NX_CHAR
- Returns:
- the value.
-
setDescription
DataNode setDescription(IDataset description)
extended description of the kicker.
Type: NX_CHAR
- Parameters:
description
- the description
-
getDescriptionScalar
java.lang.String getDescriptionScalar()
extended description of the kicker.
Type: NX_CHAR
- Returns:
- the value.
-
setDescriptionScalar
DataNode setDescriptionScalar(java.lang.String description)
extended description of the kicker.
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
-
getTiming
IDataset getTiming()
kicker timing as defined by ``description`` attribute
Type: NX_FLOAT
Units: NX_TIME
- Returns:
- the value.
-
setTiming
DataNode setTiming(IDataset timing)
kicker timing as defined by ``description`` attribute
Type: NX_FLOAT
Units: NX_TIME
- Parameters:
timing
- the timing
-
getTimingScalar
java.lang.Double getTimingScalar()
kicker timing as defined by ``description`` attribute
Type: NX_FLOAT
Units: NX_TIME
- Returns:
- the value.
-
setTimingScalar
DataNode setTimingScalar(java.lang.Double timing)
kicker timing as defined by ``description`` attribute
Type: NX_FLOAT
Units: NX_TIME
- Parameters:
timing
- the timing
-
getTimingAttributeDescription
java.lang.String getTimingAttributeDescription()
- Returns:
- the value.
-
setTimingAttributeDescription
void setTimingAttributeDescription(java.lang.String description)
- Parameters:
description
- the description
-
getSet_current
IDataset getSet_current()
current set on supply.
Type: NX_FLOAT
Units: NX_CURRENT
- Returns:
- the value.
-
setSet_current
DataNode setSet_current(IDataset set_current)
current set on supply.
Type: NX_FLOAT
Units: NX_CURRENT
- Parameters:
set_current
- the set_current
-
getSet_currentScalar
java.lang.Double getSet_currentScalar()
current set on supply.
Type: NX_FLOAT
Units: NX_CURRENT
- Returns:
- the value.
-
setSet_currentScalar
DataNode setSet_currentScalar(java.lang.Double set_current)
current set on supply.
Type: NX_FLOAT
Units: NX_CURRENT
- Parameters:
set_current
- the set_current
-
getRead_current
NXlog getRead_current()
current read from supply.
- Returns:
- the value.
-
setRead_current
void setRead_current(NXlog read_current)
current read from supply.
- Parameters:
read_current
- the read_current
-
getSet_voltage
IDataset getSet_voltage()
volage set on supply.
Type: NX_FLOAT
Units: NX_VOLTAGE
- Returns:
- the value.
-
setSet_voltage
DataNode setSet_voltage(IDataset set_voltage)
volage set on supply.
Type: NX_FLOAT
Units: NX_VOLTAGE
- Parameters:
set_voltage
- the set_voltage
-
getSet_voltageScalar
java.lang.Double getSet_voltageScalar()
volage set on supply.
Type: NX_FLOAT
Units: NX_VOLTAGE
- Returns:
- the value.
-
setSet_voltageScalar
DataNode setSet_voltageScalar(java.lang.Double set_voltage)
volage set on supply.
Type: NX_FLOAT
Units: NX_VOLTAGE
- Parameters:
set_voltage
- the set_voltage
-
getRead_voltage
NXlog getRead_voltage()
voltage read from supply.
- Returns:
- the value.
-
setRead_voltage
void setRead_voltage(NXlog read_voltage)
voltage read from supply.
- Parameters:
read_voltage
- the read_voltage