All Downloads are FREE. Search and download functionalities are using the official Maven repository.

generated.docs.javadoc.org.eclipse.dawnsci.nexus.impl.NXpositionerImpl.html Maven / Gradle / Ivy






NXpositionerImpl (h5jan API)












org.eclipse.dawnsci.nexus.impl

Class NXpositionerImpl

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy