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

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






NXsensor (h5jan API)












org.eclipse.dawnsci.nexus

Interface NXsensor

  • All Superinterfaces:
    GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject
    All Known Implementing Classes:
    NXsensorImpl


    public interface NXsensor
    extends NXobject
    A sensor used to monitor an external condition The condition itself is described in :ref:`NXenvironment`.
    • Method Detail

      • getModel

        IDataset getModel()
        Sensor identification code/model number
        Returns:
        the value.
      • setModel

        DataNode setModel(IDataset model)
        Sensor identification code/model number
        Parameters:
        model - the model
      • getModelScalar

        java.lang.String getModelScalar()
        Sensor identification code/model number
        Returns:
        the value.
      • setModelScalar

        DataNode setModelScalar(java.lang.String model)
        Sensor identification code/model number
        Parameters:
        model - the model
      • getName

        IDataset getName()
        Name for the sensor
        Returns:
        the value.
      • setName

        DataNode setName(IDataset name)
        Name for the sensor
        Parameters:
        name - the name
      • getNameScalar

        java.lang.String getNameScalar()
        Name for the sensor
        Returns:
        the value.
      • setNameScalar

        DataNode setNameScalar(java.lang.String name)
        Name for the sensor
        Parameters:
        name - the name
      • getShort_name

        IDataset getShort_name()
        Short name of sensor used e.g. on monitor display program
        Returns:
        the value.
      • setShort_name

        DataNode setShort_name(IDataset short_name)
        Short name of sensor used e.g. on monitor display program
        Parameters:
        short_name - the short_name
      • getShort_nameScalar

        java.lang.String getShort_nameScalar()
        Short name of sensor used e.g. on monitor display program
        Returns:
        the value.
      • setShort_nameScalar

        DataNode setShort_nameScalar(java.lang.String short_name)
        Short name of sensor used e.g. on monitor display program
        Parameters:
        short_name - the short_name
      • getAttached_to

        IDataset getAttached_to()
        where sensor is attached to ("sample" | "can")
        Returns:
        the value.
      • setAttached_to

        DataNode setAttached_to(IDataset attached_to)
        where sensor is attached to ("sample" | "can")
        Parameters:
        attached_to - the attached_to
      • getAttached_toScalar

        java.lang.String getAttached_toScalar()
        where sensor is attached to ("sample" | "can")
        Returns:
        the value.
      • setAttached_toScalar

        DataNode setAttached_toScalar(java.lang.String attached_to)
        where sensor is attached to ("sample" | "can")
        Parameters:
        attached_to - the attached_to
      • getGeometry

        NXgeometry getGeometry()
        Defines the axes for logged vector quantities if they are not the global instrument axes
        Returns:
        the value.
      • setGeometry

        void setGeometry(NXgeometry geometry)
        Defines the axes for logged vector quantities if they are not the global instrument axes
        Parameters:
        geometry - the geometry
      • getMeasurement

        IDataset getMeasurement()
        name for measured signal

        Enumeration:

        • temperature
        • pH
        • magnetic_field
        • electric_field
        • conductivity
        • resistance
        • voltage
        • pressure
        • flow
        • stress
        • strain
        • shear
        • surface_pressure

        Returns:
        the value.
      • setMeasurement

        DataNode setMeasurement(IDataset measurement)
        name for measured signal

        Enumeration:

        • temperature
        • pH
        • magnetic_field
        • electric_field
        • conductivity
        • resistance
        • voltage
        • pressure
        • flow
        • stress
        • strain
        • shear
        • surface_pressure

        Parameters:
        measurement - the measurement
      • getMeasurementScalar

        java.lang.String getMeasurementScalar()
        name for measured signal

        Enumeration:

        • temperature
        • pH
        • magnetic_field
        • electric_field
        • conductivity
        • resistance
        • voltage
        • pressure
        • flow
        • stress
        • strain
        • shear
        • surface_pressure

        Returns:
        the value.
      • setMeasurementScalar

        DataNode setMeasurementScalar(java.lang.String measurement)
        name for measured signal

        Enumeration:

        • temperature
        • pH
        • magnetic_field
        • electric_field
        • conductivity
        • resistance
        • voltage
        • pressure
        • flow
        • stress
        • strain
        • shear
        • surface_pressure

        Parameters:
        measurement - the measurement
      • getType

        IDataset getType()
        The type of hardware used for the measurement. Examples (suggestions but not restrictions): :Temperature: J | K | T | E | R | S | Pt100 | Rh/Fe :pH: Hg/Hg2Cl2 | Ag/AgCl | ISFET :Ion selective electrode: specify species; e.g. Ca2+ :Magnetic field: Hall :Surface pressure: wilhelmy plate
        Returns:
        the value.
      • setType

        DataNode setType(IDataset type)
        The type of hardware used for the measurement. Examples (suggestions but not restrictions): :Temperature: J | K | T | E | R | S | Pt100 | Rh/Fe :pH: Hg/Hg2Cl2 | Ag/AgCl | ISFET :Ion selective electrode: specify species; e.g. Ca2+ :Magnetic field: Hall :Surface pressure: wilhelmy plate
        Parameters:
        type - the type
      • getTypeScalar

        java.lang.String getTypeScalar()
        The type of hardware used for the measurement. Examples (suggestions but not restrictions): :Temperature: J | K | T | E | R | S | Pt100 | Rh/Fe :pH: Hg/Hg2Cl2 | Ag/AgCl | ISFET :Ion selective electrode: specify species; e.g. Ca2+ :Magnetic field: Hall :Surface pressure: wilhelmy plate
        Returns:
        the value.
      • setTypeScalar

        DataNode setTypeScalar(java.lang.String type)
        The type of hardware used for the measurement. Examples (suggestions but not restrictions): :Temperature: J | K | T | E | R | S | Pt100 | Rh/Fe :pH: Hg/Hg2Cl2 | Ag/AgCl | ISFET :Ion selective electrode: specify species; e.g. Ca2+ :Magnetic field: Hall :Surface pressure: wilhelmy plate
        Parameters:
        type - the type
      • getRun_control

        IDataset getRun_control()
        Is data collection controlled or synchronised to this quantity: 1=no, 0=to "value", 1=to "value_deriv1", etc.

        Type: NX_BOOLEAN

        Returns:
        the value.
      • setRun_control

        DataNode setRun_control(IDataset run_control)
        Is data collection controlled or synchronised to this quantity: 1=no, 0=to "value", 1=to "value_deriv1", etc.

        Type: NX_BOOLEAN

        Parameters:
        run_control - the run_control
      • getRun_controlScalar

        java.lang.Boolean getRun_controlScalar()
        Is data collection controlled or synchronised to this quantity: 1=no, 0=to "value", 1=to "value_deriv1", etc.

        Type: NX_BOOLEAN

        Returns:
        the value.
      • setRun_controlScalar

        DataNode setRun_controlScalar(java.lang.Boolean run_control)
        Is data collection controlled or synchronised to this quantity: 1=no, 0=to "value", 1=to "value_deriv1", etc.

        Type: NX_BOOLEAN

        Parameters:
        run_control - the run_control
      • getHigh_trip_value

        IDataset getHigh_trip_value()
        Upper control bound of sensor reading if using run_control

        Type: NX_FLOAT Units: NX_ANY

        Returns:
        the value.
      • setHigh_trip_value

        DataNode setHigh_trip_value(IDataset high_trip_value)
        Upper control bound of sensor reading if using run_control

        Type: NX_FLOAT Units: NX_ANY

        Parameters:
        high_trip_value - the high_trip_value
      • getHigh_trip_valueScalar

        java.lang.Double getHigh_trip_valueScalar()
        Upper control bound of sensor reading if using run_control

        Type: NX_FLOAT Units: NX_ANY

        Returns:
        the value.
      • setHigh_trip_valueScalar

        DataNode setHigh_trip_valueScalar(java.lang.Double high_trip_value)
        Upper control bound of sensor reading if using run_control

        Type: NX_FLOAT Units: NX_ANY

        Parameters:
        high_trip_value - the high_trip_value
      • getLow_trip_value

        IDataset getLow_trip_value()
        Lower control bound of sensor reading if using run_control

        Type: NX_FLOAT Units: NX_ANY

        Returns:
        the value.
      • setLow_trip_value

        DataNode setLow_trip_value(IDataset low_trip_value)
        Lower control bound of sensor reading if using run_control

        Type: NX_FLOAT Units: NX_ANY

        Parameters:
        low_trip_value - the low_trip_value
      • getLow_trip_valueScalar

        java.lang.Double getLow_trip_valueScalar()
        Lower control bound of sensor reading if using run_control

        Type: NX_FLOAT Units: NX_ANY

        Returns:
        the value.
      • setLow_trip_valueScalar

        DataNode setLow_trip_valueScalar(java.lang.Double low_trip_value)
        Lower control bound of sensor reading if using run_control

        Type: NX_FLOAT Units: NX_ANY

        Parameters:
        low_trip_value - the low_trip_value
      • getValue

        IDataset getValue()
        nominal setpoint or average value - need [n] as may be a vector

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

        Returns:
        the value.
      • setValue

        DataNode setValue(IDataset value)
        nominal setpoint or average value - need [n] as may be a vector

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

        Parameters:
        value - the value
      • getValueScalar

        java.lang.Double getValueScalar()
        nominal setpoint or average value - need [n] as may be a vector

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

        Returns:
        the value.
      • setValueScalar

        DataNode setValueScalar(java.lang.Double value)
        nominal setpoint or average value - need [n] as may be a vector

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

        Parameters:
        value - the value
      • getValue_deriv1

        IDataset getValue_deriv1()
        Nominal/average first derivative of value e.g. strain rate - same dimensions as "value" (may be a vector)

        Type: NX_FLOAT Units: NX_ANY Dimensions: 1: ;

        Returns:
        the value.
      • setValue_deriv1

        DataNode setValue_deriv1(IDataset value_deriv1)
        Nominal/average first derivative of value e.g. strain rate - same dimensions as "value" (may be a vector)

        Type: NX_FLOAT Units: NX_ANY Dimensions: 1: ;

        Parameters:
        value_deriv1 - the value_deriv1
      • getValue_deriv1Scalar

        java.lang.Double getValue_deriv1Scalar()
        Nominal/average first derivative of value e.g. strain rate - same dimensions as "value" (may be a vector)

        Type: NX_FLOAT Units: NX_ANY Dimensions: 1: ;

        Returns:
        the value.
      • setValue_deriv1Scalar

        DataNode setValue_deriv1Scalar(java.lang.Double value_deriv1)
        Nominal/average first derivative of value e.g. strain rate - same dimensions as "value" (may be a vector)

        Type: NX_FLOAT Units: NX_ANY Dimensions: 1: ;

        Parameters:
        value_deriv1 - the value_deriv1
      • getValue_deriv2

        IDataset getValue_deriv2()
        Nominal/average second derivative of value - same dimensions as "value" (may be a vector)

        Type: NX_FLOAT Units: NX_ANY Dimensions: 1: ;

        Returns:
        the value.
      • setValue_deriv2

        DataNode setValue_deriv2(IDataset value_deriv2)
        Nominal/average second derivative of value - same dimensions as "value" (may be a vector)

        Type: NX_FLOAT Units: NX_ANY Dimensions: 1: ;

        Parameters:
        value_deriv2 - the value_deriv2
      • getValue_deriv2Scalar

        java.lang.Double getValue_deriv2Scalar()
        Nominal/average second derivative of value - same dimensions as "value" (may be a vector)

        Type: NX_FLOAT Units: NX_ANY Dimensions: 1: ;

        Returns:
        the value.
      • setValue_deriv2Scalar

        DataNode setValue_deriv2Scalar(java.lang.Double value_deriv2)
        Nominal/average second derivative of value - same dimensions as "value" (may be a vector)

        Type: NX_FLOAT Units: NX_ANY Dimensions: 1: ;

        Parameters:
        value_deriv2 - the value_deriv2
      • getValue_log

        NXlog getValue_log()
        Time history of sensor readings
        Returns:
        the value.
      • setValue_log

        void setValue_log(NXlog value_log)
        Time history of sensor readings
        Parameters:
        value_log - the value_log
      • getValue_deriv1_log

        NXlog getValue_deriv1_log()
        Time history of first derivative of sensor readings
        Returns:
        the value.
      • setValue_deriv1_log

        void setValue_deriv1_log(NXlog value_deriv1_log)
        Time history of first derivative of sensor readings
        Parameters:
        value_deriv1_log - the value_deriv1_log
      • getValue_deriv2_log

        NXlog getValue_deriv2_log()
        Time history of second derivative of sensor readings
        Returns:
        the value.
      • setValue_deriv2_log

        void setValue_deriv2_log(NXlog value_deriv2_log)
        Time history of second derivative of sensor readings
        Parameters:
        value_deriv2_log - the value_deriv2_log
      • getExternal_field_brief

        IDataset getExternal_field_brief()

        Enumeration:

        • along beam
        • across beam
        • transverse
        • solenoidal
        • flow shear gradient
        • flow vorticity

        Returns:
        the value.
      • setExternal_field_brief

        DataNode setExternal_field_brief(IDataset external_field_brief)

        Enumeration:

        • along beam
        • across beam
        • transverse
        • solenoidal
        • flow shear gradient
        • flow vorticity

        Parameters:
        external_field_brief - the external_field_brief
      • getExternal_field_briefScalar

        java.lang.String getExternal_field_briefScalar()

        Enumeration:

        • along beam
        • across beam
        • transverse
        • solenoidal
        • flow shear gradient
        • flow vorticity

        Returns:
        the value.
      • setExternal_field_briefScalar

        DataNode setExternal_field_briefScalar(java.lang.String external_field_brief)

        Enumeration:

        • along beam
        • across beam
        • transverse
        • solenoidal
        • flow shear gradient
        • flow vorticity

        Parameters:
        external_field_brief - the external_field_brief
      • getExternal_field_full

        NXorientation getExternal_field_full()
        For complex external fields not satisfied by External_field_brief
        Returns:
        the value.
      • setExternal_field_full

        void setExternal_field_full(NXorientation external_field_full)
        For complex external fields not satisfied by External_field_brief
        Parameters:
        external_field_full - the external_field_full




© 2015 - 2024 Weber Informatics LLC | Privacy Policy