NXpositioner

Status:

base class, extends NXobject

Description:

A generic positioner such as a motor or piezo-electric transducer.

Symbols:

No symbol table

Groups cited:

none

Structure:

@default: (optional) NX_CHAR

Declares which child group contains a path leading to a NXdata group.

It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion.

name: (optional) NX_CHAR

symbolic or mnemonic name (one word)

description: (optional) NX_CHAR

description of positioner

value[n]: (optional) NX_NUMBER {units=NX_ANY}

best known value of positioner - need [n] as may be scanned

raw_value[n]: (optional) NX_NUMBER {units=NX_ANY}

raw value of positioner - need [n] as may be scanned

target_value[n]: (optional) NX_NUMBER {units=NX_ANY}

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

tolerance[n]: (optional) NX_NUMBER {units=NX_ANY}

maximum allowable difference between target_value and value

soft_limit_min: (optional) NX_NUMBER {units=NX_ANY}

minimum allowed limit to set value

soft_limit_max: (optional) NX_NUMBER {units=NX_ANY}

maximum allowed limit to set value

velocity: (optional) NX_NUMBER {units=NX_ANY}

velocity of the positioner (distance moved per unit time)

acceleration_time: (optional) NX_NUMBER {units=NX_ANY}

time to ramp the velocity up to full speed

controller_record: (optional) NX_CHAR

Hardware device record, e.g. EPICS process variable, taco/tango …

Hypertext Anchors

Table of hypertext anchors for all groups, fields, attributes, and links defined in this class.

documentation (reST source) anchor

web page (HTML) anchor

/NXpositioner/acceleration_time-field

#nxpositioner-acceleration-time-field

/NXpositioner/controller_record-field

#nxpositioner-controller-record-field

/NXpositioner/description-field

#nxpositioner-description-field

/NXpositioner/name-field

#nxpositioner-name-field

/NXpositioner/raw_value-field

#nxpositioner-raw-value-field

/NXpositioner/soft_limit_max-field

#nxpositioner-soft-limit-max-field

/NXpositioner/soft_limit_min-field

#nxpositioner-soft-limit-min-field

/NXpositioner/target_value-field

#nxpositioner-target-value-field

/NXpositioner/tolerance-field

#nxpositioner-tolerance-field

/NXpositioner/value-field

#nxpositioner-value-field

/NXpositioner/velocity-field

#nxpositioner-velocity-field

/NXpositioner@default-attribute

#nxpositioner-default-attribute

NXDL Source:

https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/base_classes/NXpositioner.nxdl.xml