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






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


All Known Implementing Classes:
NXpositionerImpl




public interface NXpositioner
extends NXobject
A generic positioner such as a motor or piezo-electric transducer.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_ACCELERATION_TIME 


static java.lang.String
NX_CONTROLLER_RECORD 


static java.lang.String
NX_DESCRIPTION 


static java.lang.String
NX_NAME 


static java.lang.String
NX_RAW_VALUE 


static java.lang.String
NX_SOFT_LIMIT_MAX 


static java.lang.String
NX_SOFT_LIMIT_MIN 


static java.lang.String
NX_TARGET_VALUE 


static java.lang.String
NX_TOLERANCE 


static java.lang.String
NX_VALUE 


static java.lang.String
NX_VELOCITY 






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
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)



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 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_NAME
static final java.lang.String NX_NAME

See Also:
Constant Field Values








NX_DESCRIPTION
static final java.lang.String NX_DESCRIPTION

See Also:
Constant Field Values








NX_VALUE
static final java.lang.String NX_VALUE

See Also:
Constant Field Values








NX_RAW_VALUE
static final java.lang.String NX_RAW_VALUE

See Also:
Constant Field Values








NX_TARGET_VALUE
static final java.lang.String NX_TARGET_VALUE

See Also:
Constant Field Values








NX_TOLERANCE
static final java.lang.String NX_TOLERANCE

See Also:
Constant Field Values








NX_SOFT_LIMIT_MIN
static final java.lang.String NX_SOFT_LIMIT_MIN

See Also:
Constant Field Values








NX_SOFT_LIMIT_MAX
static final java.lang.String NX_SOFT_LIMIT_MAX

See Also:
Constant Field Values








NX_VELOCITY
static final java.lang.String NX_VELOCITY

See Also:
Constant Field Values








NX_ACCELERATION_TIME
static final java.lang.String NX_ACCELERATION_TIME

See Also:
Constant Field Values








NX_CONTROLLER_RECORD
static final java.lang.String NX_CONTROLLER_RECORD

See Also:
Constant Field Values










Method Detail





getName
IDataset getName()
symbolic or mnemonic name (one word)

Returns:
the value.








setName
DataNode setName(IDataset name)
symbolic or mnemonic name (one word)

Parameters:
name - the name








getNameScalar
java.lang.String getNameScalar()
symbolic or mnemonic name (one word)

Returns:
the value.








setNameScalar
DataNode setNameScalar(java.lang.String name)
symbolic or mnemonic name (one word)

Parameters:
name - the name








getDescription
IDataset getDescription()
description of positioner

Returns:
the value.








setDescription
DataNode setDescription(IDataset description)
description of positioner

Parameters:
description - the description








getDescriptionScalar
java.lang.String getDescriptionScalar()
description of positioner

Returns:
the value.








setDescriptionScalar
DataNode setDescriptionScalar(java.lang.String description)
description of positioner

Parameters:
description - the description








getValue
IDataset getValue()
best known value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Returns:
the value.








setValue
DataNode setValue(IDataset value)
best known value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Parameters:
value - the value








getValueScalar
java.lang.Number getValueScalar()
best known value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Returns:
the value.








setValueScalar
DataNode setValueScalar(java.lang.Number value)
best known value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Parameters:
value - the value








getRaw_value
IDataset getRaw_value()
raw value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Returns:
the value.








setRaw_value
DataNode setRaw_value(IDataset raw_value)
raw value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Parameters:
raw_value - the raw_value








getRaw_valueScalar
java.lang.Number getRaw_valueScalar()
raw value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Returns:
the value.








setRaw_valueScalar
DataNode setRaw_valueScalar(java.lang.Number raw_value)
raw value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Parameters:
raw_value - the raw_value








getTarget_value
IDataset getTarget_value()
targeted (commanded) value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Returns:
the value.








setTarget_value
DataNode setTarget_value(IDataset target_value)
targeted (commanded) value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Parameters:
target_value - the target_value








getTarget_valueScalar
java.lang.Number getTarget_valueScalar()
targeted (commanded) value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Returns:
the value.








setTarget_valueScalar
DataNode setTarget_valueScalar(java.lang.Number target_value)
targeted (commanded) value of positioner - need [n] as may be scanned
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Parameters:
target_value - the target_value








getTolerance
IDataset getTolerance()
maximum allowable difference between target_value and value
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Returns:
the value.








setTolerance
DataNode setTolerance(IDataset tolerance)
maximum allowable difference between target_value and value
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Parameters:
tolerance - the tolerance








getToleranceScalar
java.lang.Number getToleranceScalar()
maximum allowable difference between target_value and value
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Returns:
the value.








setToleranceScalar
DataNode setToleranceScalar(java.lang.Number tolerance)
maximum allowable difference between target_value and value
 

 Type: NX_NUMBER
 Units: NX_ANY
 Dimensions: 1: n;
 

Parameters:
tolerance - the tolerance








getSoft_limit_min
IDataset getSoft_limit_min()
minimum allowed limit to set value
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setSoft_limit_min
DataNode setSoft_limit_min(IDataset soft_limit_min)
minimum allowed limit to set value
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
soft_limit_min - the soft_limit_min








getSoft_limit_minScalar
java.lang.Number getSoft_limit_minScalar()
minimum allowed limit to set value
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setSoft_limit_minScalar
DataNode setSoft_limit_minScalar(java.lang.Number soft_limit_min)
minimum allowed limit to set value
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
soft_limit_min - the soft_limit_min








getSoft_limit_max
IDataset getSoft_limit_max()
maximum allowed limit to set value
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setSoft_limit_max
DataNode setSoft_limit_max(IDataset soft_limit_max)
maximum allowed limit to set value
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
soft_limit_max - the soft_limit_max








getSoft_limit_maxScalar
java.lang.Number getSoft_limit_maxScalar()
maximum allowed limit to set value
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setSoft_limit_maxScalar
DataNode setSoft_limit_maxScalar(java.lang.Number soft_limit_max)
maximum allowed limit to set value
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
soft_limit_max - the soft_limit_max








getVelocity
IDataset getVelocity()
velocity of the positioner (distance moved per unit time)
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setVelocity
DataNode setVelocity(IDataset velocity)
velocity of the positioner (distance moved per unit time)
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
velocity - the velocity








getVelocityScalar
java.lang.Number getVelocityScalar()
velocity of the positioner (distance moved per unit time)
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setVelocityScalar
DataNode setVelocityScalar(java.lang.Number velocity)
velocity of the positioner (distance moved per unit time)
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
velocity - the velocity








getAcceleration_time
IDataset getAcceleration_time()
time to ramp the velocity up to full speed
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setAcceleration_time
DataNode setAcceleration_time(IDataset acceleration_time)
time to ramp the velocity up to full speed
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
acceleration_time - the acceleration_time








getAcceleration_timeScalar
java.lang.Number getAcceleration_timeScalar()
time to ramp the velocity up to full speed
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Returns:
the value.








setAcceleration_timeScalar
DataNode setAcceleration_timeScalar(java.lang.Number acceleration_time)
time to ramp the velocity up to full speed
 

 Type: NX_NUMBER
 Units: NX_ANY
 

Parameters:
acceleration_time - the acceleration_time








getController_record
IDataset getController_record()
Hardware device record, e.g. EPICS process variable, taco/tango ...

Returns:
the value.








setController_record
DataNode setController_record(IDataset controller_record)
Hardware device record, e.g. EPICS process variable, taco/tango ...

Parameters:
controller_record - the controller_record








getController_recordScalar
java.lang.String getController_recordScalar()
Hardware device record, e.g. EPICS process variable, taco/tango ...

Returns:
the value.








setController_recordScalar
DataNode setController_recordScalar(java.lang.String controller_record)
Hardware device record, e.g. EPICS process variable, taco/tango ...

Parameters:
controller_record - the controller_record














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