Package org.eclipse.dawnsci.nexus

Interface NXpositioner

All Superinterfaces:
GroupNode, Iterable<NodeLink>, Node, NXcomponent, NXobject
public interface NXpositioner extends NXcomponent
A generic positioner such as a motor or piezo-electric transducer.

  • Field Details

  • Method Details

    • getName

      org.eclipse.january.dataset.Dataset getName()
      symbolic or mnemonic name (one word)
      Specified by:
      getName in interface NXcomponent
      Returns:
      the value.

    • setName

      DataNode setName(org.eclipse.january.dataset.IDataset nameDataset)
      symbolic or mnemonic name (one word)
      Specified by:
      setName in interface NXcomponent
      Parameters:
      nameDataset - the nameDataset

    • getNameScalar

      String getNameScalar()
      symbolic or mnemonic name (one word)
      Specified by:
      getNameScalar in interface NXcomponent
      Returns:
      the value.

    • setNameScalar

      DataNode setNameScalar(String nameValue)
      symbolic or mnemonic name (one word)
      Specified by:
      setNameScalar in interface NXcomponent
      Parameters:
      name - the name

    • getDescription

      org.eclipse.january.dataset.Dataset getDescription()
      description of positioner
      Specified by:
      getDescription in interface NXcomponent
      Returns:
      the value.

    • setDescription

      DataNode setDescription(org.eclipse.january.dataset.IDataset descriptionDataset)
      description of positioner
      Specified by:
      setDescription in interface NXcomponent
      Parameters:
      descriptionDataset - the descriptionDataset

    • getDescriptionScalar

      String getDescriptionScalar()
      description of positioner
      Specified by:
      getDescriptionScalar in interface NXcomponent
      Returns:
      the value.

    • setDescriptionScalar

      DataNode setDescriptionScalar(String descriptionValue)
      description of positioner
      Specified by:
      setDescriptionScalar in interface NXcomponent
      Parameters:
      description - the description

    • getValue

      org.eclipse.january.dataset.Dataset 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(org.eclipse.january.dataset.IDataset valueDataset)
      best known value of positioner - need [n] as may be scanned

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

      Parameters:
      valueDataset - the valueDataset

    • getValueScalar

      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(Number valueValue)
      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

      org.eclipse.january.dataset.Dataset 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(org.eclipse.january.dataset.IDataset raw_valueDataset)
      raw value of positioner - need [n] as may be scanned

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

      Parameters:
      raw_valueDataset - the raw_valueDataset

    • getRaw_valueScalar

      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(Number raw_valueValue)
      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

      org.eclipse.january.dataset.Dataset 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(org.eclipse.january.dataset.IDataset target_valueDataset)
      targeted (commanded) value of positioner - need [n] as may be scanned

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

      Parameters:
      target_valueDataset - the target_valueDataset

    • getTarget_valueScalar

      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(Number target_valueValue)
      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

      org.eclipse.january.dataset.Dataset getTolerance()
      maximum allowable difference between target_value and value

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

      Returns:
      the value.

    • setTolerance

      DataNode setTolerance(org.eclipse.january.dataset.IDataset toleranceDataset)
      maximum allowable difference between target_value and value

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

      Parameters:
      toleranceDataset - the toleranceDataset

    • getToleranceScalar

      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(Number toleranceValue)
      maximum allowable difference between target_value and value

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

      Parameters:
      tolerance - the tolerance

    • getSoft_limit_min

      org.eclipse.january.dataset.Dataset 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(org.eclipse.january.dataset.IDataset soft_limit_minDataset)
      minimum allowed limit to set value

      Type: NX_NUMBER Units: NX_ANY

      Parameters:
      soft_limit_minDataset - the soft_limit_minDataset

    • getSoft_limit_minScalar

      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(Number soft_limit_minValue)
      minimum allowed limit to set value

      Type: NX_NUMBER Units: NX_ANY

      Parameters:
      soft_limit_min - the soft_limit_min

    • getSoft_limit_max

      org.eclipse.january.dataset.Dataset 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(org.eclipse.january.dataset.IDataset soft_limit_maxDataset)
      maximum allowed limit to set value

      Type: NX_NUMBER Units: NX_ANY

      Parameters:
      soft_limit_maxDataset - the soft_limit_maxDataset

    • getSoft_limit_maxScalar

      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(Number soft_limit_maxValue)
      maximum allowed limit to set value

      Type: NX_NUMBER Units: NX_ANY

      Parameters:
      soft_limit_max - the soft_limit_max

    • getVelocity

      org.eclipse.january.dataset.Dataset getVelocity()
      velocity of the positioner (distance moved per unit time)

      Type: NX_NUMBER Units: NX_ANY

      Returns:
      the value.

    • setVelocity

      DataNode setVelocity(org.eclipse.january.dataset.IDataset velocityDataset)
      velocity of the positioner (distance moved per unit time)

      Type: NX_NUMBER Units: NX_ANY

      Parameters:
      velocityDataset - the velocityDataset

    • getVelocityScalar

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

      Type: NX_NUMBER Units: NX_ANY

      Returns:
      the value.

    • setVelocityScalar

      DataNode setVelocityScalar(Number velocityValue)
      velocity of the positioner (distance moved per unit time)

      Type: NX_NUMBER Units: NX_ANY

      Parameters:
      velocity - the velocity

    • getAcceleration_time

      org.eclipse.january.dataset.Dataset 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(org.eclipse.january.dataset.IDataset acceleration_timeDataset)
      time to ramp the velocity up to full speed

      Type: NX_NUMBER Units: NX_ANY

      Parameters:
      acceleration_timeDataset - the acceleration_timeDataset

    • getAcceleration_timeScalar

      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(Number acceleration_timeValue)
      time to ramp the velocity up to full speed

      Type: NX_NUMBER Units: NX_ANY

      Parameters:
      acceleration_time - the acceleration_time

    • getController_record

      org.eclipse.january.dataset.Dataset getController_record()
      Hardware device record, e.g. EPICS process variable, taco/tango ...
      Returns:
      the value.

    • setController_record

      DataNode setController_record(org.eclipse.january.dataset.IDataset controller_recordDataset)
      Hardware device record, e.g. EPICS process variable, taco/tango ...
      Parameters:
      controller_recordDataset - the controller_recordDataset

    • getController_recordScalar

      String getController_recordScalar()
      Hardware device record, e.g. EPICS process variable, taco/tango ...
      Returns:
      the value.

    • setController_recordScalar

      DataNode setController_recordScalar(String controller_recordValue)
      Hardware device record, e.g. EPICS process variable, taco/tango ...
      Parameters:
      controller_record - the controller_record

    • getDepends_on

      org.eclipse.january.dataset.Dataset getDepends_on()
      .. todo:: Add a definition for the reference point of a positioner.

      Type: NX_CHAR

      Specified by:
      getDepends_on in interface NXcomponent
      Returns:
      the value.

    • setDepends_on

      DataNode setDepends_on(org.eclipse.january.dataset.IDataset depends_onDataset)
      .. todo:: Add a definition for the reference point of a positioner.

      Type: NX_CHAR

      Specified by:
      setDepends_on in interface NXcomponent
      Parameters:
      depends_onDataset - the depends_onDataset

    • getDepends_onScalar

      String getDepends_onScalar()
      .. todo:: Add a definition for the reference point of a positioner.

      Type: NX_CHAR

      Specified by:
      getDepends_onScalar in interface NXcomponent
      Returns:
      the value.

    • setDepends_onScalar

      DataNode setDepends_onScalar(String depends_onValue)
      .. todo:: Add a definition for the reference point of a positioner.

      Type: NX_CHAR

      Specified by:
      setDepends_onScalar in interface NXcomponent
      Parameters:
      depends_on - the depends_on