3.3.1.40. NXpositioner

Status:

base class, extends NXobject, version 1.0

Description:

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

It is used to document the current information of a piece of beam line equipment. Note: When using multiple NXpositioner groups, it is suggested to place them inside a NXcollection group. In such cases, when NXpositioner is used in another class, NXcollection/NXpositioner is then constructed.

Symbols:

No symbol table

Groups cited:

none

Structure:

name: NX_CHAR

symbolic or mnemonic name (one word)

description: NX_CHAR

description of positioner

value[n]: NX_NUMBER {units=NX_ANY}

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

raw_value[n]: NX_NUMBER {units=NX_ANY}

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

target_value[n]: NX_NUMBER {units=NX_ANY}

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

tolerance[n]: NX_NUMBER {units=NX_ANY}

maximum allowable difference between target_value and value

soft_limit_min: NX_NUMBER {units=NX_ANY}

minimum allowed limit to set value

soft_limit_max: NX_NUMBER {units=NX_ANY}

maximum allowed limit to set value

velocity: NX_NUMBER {units=NX_ANY}

velocity of the positioner (distance moved per unit time)

acceleration_time: NX_NUMBER {units=NX_ANY}

time to ramp the velocity up to full speed

controller_record: NX_CHAR

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

NXDL Source:

https://github.com/nexusformat/definitions/blob/master/base_classes/NXpositioner.nxdl.xml