generated.docs.javadoc.org.eclipse.dawnsci.nexus.impl.NXpositionerImpl.html Maven / Gradle / Ivy
NXpositionerImpl (h5jan API)
org.eclipse.dawnsci.nexus.impl
Class NXpositionerImpl
- 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.NXpositionerImpl
-
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXobject, NXpositioner
public class NXpositionerImpl
extends NXobjectImpl
implements NXpositioner
A generic positioner such as a motor or piezo-electric transducer.
- 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.NXpositioner
NX_ACCELERATION_TIME, NX_CONTROLLER_RECORD, NX_DESCRIPTION, NX_NAME, NX_RAW_VALUE, NX_SOFT_LIMIT_MAX, NX_SOFT_LIMIT_MIN, NX_TARGET_VALUE, NX_TOLERANCE, NX_VALUE, NX_VELOCITY
-
Constructor Summary
Constructors
Constructor and Description
NXpositionerImpl()
NXpositionerImpl(long oid)
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
IDataset
getAcceleration_time()
time to ramp the velocity up to full speed
java.lang.Number
getAcceleration_timeScalar()
time to ramp the velocity up to full speed
IDataset
getController_record()
Hardware device record, e.g.
java.lang.String
getController_recordScalar()
Hardware device record, e.g.
IDataset
getDescription()
description of positioner
java.lang.String
getDescriptionScalar()
description of positioner
IDataset
getName()
symbolic or mnemonic name (one word)
java.lang.String
getNameScalar()
symbolic or mnemonic name (one word)
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
getRaw_value()
raw value of positioner - need [n] as may be scanned
java.lang.Number
getRaw_valueScalar()
raw value of positioner - need [n] as may be scanned
IDataset
getSoft_limit_max()
maximum allowed limit to set value
java.lang.Number
getSoft_limit_maxScalar()
maximum allowed limit to set value
IDataset
getSoft_limit_min()
minimum allowed limit to set value
java.lang.Number
getSoft_limit_minScalar()
minimum allowed limit to set value
IDataset
getTarget_value()
targeted (commanded) value of positioner - need [n] as may be scanned
java.lang.Number
getTarget_valueScalar()
targeted (commanded) value of positioner - need [n] as may be scanned
IDataset
getTolerance()
maximum allowable difference between target_value and value
java.lang.Number
getToleranceScalar()
maximum allowable difference between target_value and value
IDataset
getValue()
best known value of positioner - need [n] as may be scanned
java.lang.Number
getValueScalar()
best known value of positioner - need [n] as may be scanned
IDataset
getVelocity()
velocity of the positioner (distance moved per unit time)
java.lang.Number
getVelocityScalar()
velocity of the positioner (distance moved per unit time)
DataNode
setAcceleration_time(IDataset acceleration_time)
time to ramp the velocity up to full speed
DataNode
setAcceleration_timeScalar(java.lang.Number acceleration_time)
time to ramp the velocity up to full speed
DataNode
setController_record(IDataset controller_record)
Hardware device record, e.g.
DataNode
setController_recordScalar(java.lang.String controller_record)
Hardware device record, e.g.
DataNode
setDescription(IDataset description)
description of positioner
DataNode
setDescriptionScalar(java.lang.String description)
description of positioner
DataNode
setName(IDataset name)
symbolic or mnemonic name (one word)
DataNode
setNameScalar(java.lang.String name)
symbolic or mnemonic name (one word)
DataNode
setRaw_value(IDataset raw_value)
raw value of positioner - need [n] as may be scanned
DataNode
setRaw_valueScalar(java.lang.Number raw_value)
raw value of positioner - need [n] as may be scanned
DataNode
setSoft_limit_max(IDataset soft_limit_max)
maximum allowed limit to set value
DataNode
setSoft_limit_maxScalar(java.lang.Number soft_limit_max)
maximum allowed limit to set value
DataNode
setSoft_limit_min(IDataset soft_limit_min)
minimum allowed limit to set value
DataNode
setSoft_limit_minScalar(java.lang.Number soft_limit_min)
minimum allowed limit to set value
DataNode
setTarget_value(IDataset target_value)
targeted (commanded) value of positioner - need [n] as may be scanned
DataNode
setTarget_valueScalar(java.lang.Number target_value)
targeted (commanded) value of positioner - need [n] as may be scanned
DataNode
setTolerance(IDataset tolerance)
maximum allowable difference between target_value and value
DataNode
setToleranceScalar(java.lang.Number tolerance)
maximum allowable difference between target_value and value
DataNode
setValue(IDataset value)
best known value of positioner - need [n] as may be scanned
DataNode
setValueScalar(java.lang.Number value)
best known value of positioner - need [n] as may be scanned
DataNode
setVelocity(IDataset velocity)
velocity of the positioner (distance moved per unit time)
DataNode
setVelocityScalar(java.lang.Number velocity)
velocity of the positioner (distance moved per unit time)
-
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
-
NXpositionerImpl
public NXpositionerImpl()
-
NXpositionerImpl
public NXpositionerImpl(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
-
getName
public IDataset getName()
Description copied from interface: NXpositioner
symbolic or mnemonic name (one word)
- Specified by:
getName
in interface NXpositioner
- Returns:
- the value.
-
getNameScalar
public java.lang.String getNameScalar()
Description copied from interface: NXpositioner
symbolic or mnemonic name (one word)
- Specified by:
getNameScalar
in interface NXpositioner
- Returns:
- the value.
-
setName
public DataNode setName(IDataset name)
Description copied from interface: NXpositioner
symbolic or mnemonic name (one word)
- Specified by:
setName
in interface NXpositioner
- Parameters:
name
- the name
-
setNameScalar
public DataNode setNameScalar(java.lang.String name)
Description copied from interface: NXpositioner
symbolic or mnemonic name (one word)
- Specified by:
setNameScalar
in interface NXpositioner
- Parameters:
name
- the name
-
getDescription
public IDataset getDescription()
Description copied from interface: NXpositioner
description of positioner
- Specified by:
getDescription
in interface NXpositioner
- Returns:
- the value.
-
getDescriptionScalar
public java.lang.String getDescriptionScalar()
Description copied from interface: NXpositioner
description of positioner
- Specified by:
getDescriptionScalar
in interface NXpositioner
- Returns:
- the value.
-
setDescription
public DataNode setDescription(IDataset description)
Description copied from interface: NXpositioner
description of positioner
- Specified by:
setDescription
in interface NXpositioner
- Parameters:
description
- the description
-
setDescriptionScalar
public DataNode setDescriptionScalar(java.lang.String description)
Description copied from interface: NXpositioner
description of positioner
- Specified by:
setDescriptionScalar
in interface NXpositioner
- Parameters:
description
- the description
-
getValue
public IDataset getValue()
Description copied from interface: NXpositioner
best known value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
getValue
in interface NXpositioner
- Returns:
- the value.
-
getValueScalar
public java.lang.Number getValueScalar()
Description copied from interface: NXpositioner
best known value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
getValueScalar
in interface NXpositioner
- Returns:
- the value.
-
setValue
public DataNode setValue(IDataset value)
Description copied from interface: NXpositioner
best known value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
setValue
in interface NXpositioner
- Parameters:
value
- the value
-
setValueScalar
public DataNode setValueScalar(java.lang.Number value)
Description copied from interface: NXpositioner
best known value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
setValueScalar
in interface NXpositioner
- Parameters:
value
- the value
-
getRaw_value
public IDataset getRaw_value()
Description copied from interface: NXpositioner
raw value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
getRaw_value
in interface NXpositioner
- Returns:
- the value.
-
getRaw_valueScalar
public java.lang.Number getRaw_valueScalar()
Description copied from interface: NXpositioner
raw value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
getRaw_valueScalar
in interface NXpositioner
- Returns:
- the value.
-
setRaw_value
public DataNode setRaw_value(IDataset raw_value)
Description copied from interface: NXpositioner
raw value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
setRaw_value
in interface NXpositioner
- Parameters:
raw_value
- the raw_value
-
setRaw_valueScalar
public DataNode setRaw_valueScalar(java.lang.Number raw_value)
Description copied from interface: NXpositioner
raw value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
setRaw_valueScalar
in interface NXpositioner
- Parameters:
raw_value
- the raw_value
-
getTarget_value
public IDataset getTarget_value()
Description copied from interface: NXpositioner
targeted (commanded) value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
getTarget_value
in interface NXpositioner
- Returns:
- the value.
-
getTarget_valueScalar
public java.lang.Number getTarget_valueScalar()
Description copied from interface: NXpositioner
targeted (commanded) value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
getTarget_valueScalar
in interface NXpositioner
- Returns:
- the value.
-
setTarget_value
public DataNode setTarget_value(IDataset target_value)
Description copied from interface: NXpositioner
targeted (commanded) value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
setTarget_value
in interface NXpositioner
- Parameters:
target_value
- the target_value
-
setTarget_valueScalar
public DataNode setTarget_valueScalar(java.lang.Number target_value)
Description copied from interface: NXpositioner
targeted (commanded) value of positioner - need [n] as may be scanned
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
setTarget_valueScalar
in interface NXpositioner
- Parameters:
target_value
- the target_value
-
getTolerance
public IDataset getTolerance()
Description copied from interface: NXpositioner
maximum allowable difference between target_value and value
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
getTolerance
in interface NXpositioner
- Returns:
- the value.
-
getToleranceScalar
public java.lang.Number getToleranceScalar()
Description copied from interface: NXpositioner
maximum allowable difference between target_value and value
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
getToleranceScalar
in interface NXpositioner
- Returns:
- the value.
-
setTolerance
public DataNode setTolerance(IDataset tolerance)
Description copied from interface: NXpositioner
maximum allowable difference between target_value and value
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
setTolerance
in interface NXpositioner
- Parameters:
tolerance
- the tolerance
-
setToleranceScalar
public DataNode setToleranceScalar(java.lang.Number tolerance)
Description copied from interface: NXpositioner
maximum allowable difference between target_value and value
Type: NX_NUMBER
Units: NX_ANY
Dimensions: 1: n;
- Specified by:
setToleranceScalar
in interface NXpositioner
- Parameters:
tolerance
- the tolerance
-
getSoft_limit_min
public IDataset getSoft_limit_min()
Description copied from interface: NXpositioner
minimum allowed limit to set value
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
getSoft_limit_min
in interface NXpositioner
- Returns:
- the value.
-
getSoft_limit_minScalar
public java.lang.Number getSoft_limit_minScalar()
Description copied from interface: NXpositioner
minimum allowed limit to set value
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
getSoft_limit_minScalar
in interface NXpositioner
- Returns:
- the value.
-
setSoft_limit_min
public DataNode setSoft_limit_min(IDataset soft_limit_min)
Description copied from interface: NXpositioner
minimum allowed limit to set value
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
setSoft_limit_min
in interface NXpositioner
- Parameters:
soft_limit_min
- the soft_limit_min
-
setSoft_limit_minScalar
public DataNode setSoft_limit_minScalar(java.lang.Number soft_limit_min)
Description copied from interface: NXpositioner
minimum allowed limit to set value
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
setSoft_limit_minScalar
in interface NXpositioner
- Parameters:
soft_limit_min
- the soft_limit_min
-
getSoft_limit_max
public IDataset getSoft_limit_max()
Description copied from interface: NXpositioner
maximum allowed limit to set value
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
getSoft_limit_max
in interface NXpositioner
- Returns:
- the value.
-
getSoft_limit_maxScalar
public java.lang.Number getSoft_limit_maxScalar()
Description copied from interface: NXpositioner
maximum allowed limit to set value
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
getSoft_limit_maxScalar
in interface NXpositioner
- Returns:
- the value.
-
setSoft_limit_max
public DataNode setSoft_limit_max(IDataset soft_limit_max)
Description copied from interface: NXpositioner
maximum allowed limit to set value
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
setSoft_limit_max
in interface NXpositioner
- Parameters:
soft_limit_max
- the soft_limit_max
-
setSoft_limit_maxScalar
public DataNode setSoft_limit_maxScalar(java.lang.Number soft_limit_max)
Description copied from interface: NXpositioner
maximum allowed limit to set value
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
setSoft_limit_maxScalar
in interface NXpositioner
- Parameters:
soft_limit_max
- the soft_limit_max
-
getVelocity
public IDataset getVelocity()
Description copied from interface: NXpositioner
velocity of the positioner (distance moved per unit time)
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
getVelocity
in interface NXpositioner
- Returns:
- the value.
-
getVelocityScalar
public java.lang.Number getVelocityScalar()
Description copied from interface: NXpositioner
velocity of the positioner (distance moved per unit time)
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
getVelocityScalar
in interface NXpositioner
- Returns:
- the value.
-
setVelocity
public DataNode setVelocity(IDataset velocity)
Description copied from interface: NXpositioner
velocity of the positioner (distance moved per unit time)
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
setVelocity
in interface NXpositioner
- Parameters:
velocity
- the velocity
-
setVelocityScalar
public DataNode setVelocityScalar(java.lang.Number velocity)
Description copied from interface: NXpositioner
velocity of the positioner (distance moved per unit time)
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
setVelocityScalar
in interface NXpositioner
- Parameters:
velocity
- the velocity
-
getAcceleration_time
public IDataset getAcceleration_time()
Description copied from interface: NXpositioner
time to ramp the velocity up to full speed
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
getAcceleration_time
in interface NXpositioner
- Returns:
- the value.
-
getAcceleration_timeScalar
public java.lang.Number getAcceleration_timeScalar()
Description copied from interface: NXpositioner
time to ramp the velocity up to full speed
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
getAcceleration_timeScalar
in interface NXpositioner
- Returns:
- the value.
-
setAcceleration_time
public DataNode setAcceleration_time(IDataset acceleration_time)
Description copied from interface: NXpositioner
time to ramp the velocity up to full speed
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
setAcceleration_time
in interface NXpositioner
- Parameters:
acceleration_time
- the acceleration_time
-
setAcceleration_timeScalar
public DataNode setAcceleration_timeScalar(java.lang.Number acceleration_time)
Description copied from interface: NXpositioner
time to ramp the velocity up to full speed
Type: NX_NUMBER
Units: NX_ANY
- Specified by:
setAcceleration_timeScalar
in interface NXpositioner
- Parameters:
acceleration_time
- the acceleration_time
-
getController_record
public IDataset getController_record()
Description copied from interface: NXpositioner
Hardware device record, e.g. EPICS process variable, taco/tango ...
- Specified by:
getController_record
in interface NXpositioner
- Returns:
- the value.
-
getController_recordScalar
public java.lang.String getController_recordScalar()
Description copied from interface: NXpositioner
Hardware device record, e.g. EPICS process variable, taco/tango ...
- Specified by:
getController_recordScalar
in interface NXpositioner
- Returns:
- the value.
-
setController_record
public DataNode setController_record(IDataset controller_record)
Description copied from interface: NXpositioner
Hardware device record, e.g. EPICS process variable, taco/tango ...
- Specified by:
setController_record
in interface NXpositioner
- Parameters:
controller_record
- the controller_record
-
setController_recordScalar
public DataNode setController_recordScalar(java.lang.String controller_record)
Description copied from interface: NXpositioner
Hardware device record, e.g. EPICS process variable, taco/tango ...
- Specified by:
setController_recordScalar
in interface NXpositioner
- Parameters:
controller_record
- the controller_record