generated.docs.javadoc.org.eclipse.dawnsci.nexus.NXsensor.html Maven / Gradle / Ivy
NXsensor (h5jan API)
org.eclipse.dawnsci.nexus
Interface NXsensor
-
-
Field Summary
Fields
Modifier and Type
Field and Description
static java.lang.String
NX_ATTACHED_TO
static java.lang.String
NX_EXTERNAL_FIELD_BRIEF
static java.lang.String
NX_HIGH_TRIP_VALUE
static java.lang.String
NX_LOW_TRIP_VALUE
static java.lang.String
NX_MEASUREMENT
static java.lang.String
NX_MODEL
static java.lang.String
NX_NAME
static java.lang.String
NX_RUN_CONTROL
static java.lang.String
NX_SHORT_NAME
static java.lang.String
NX_TYPE
static java.lang.String
NX_VALUE
static java.lang.String
NX_VALUE_DERIV1
static java.lang.String
NX_VALUE_DERIV2
-
Method Summary
All Methods Instance Methods Abstract Methods
Modifier and Type
Method and Description
IDataset
getAttached_to()
where sensor is attached to ("sample" | "can")
java.lang.String
getAttached_toScalar()
where sensor is attached to ("sample" | "can")
IDataset
getExternal_field_brief()
java.lang.String
getExternal_field_briefScalar()
NXorientation
getExternal_field_full()
For complex external fields not satisfied by External_field_brief
NXgeometry
getGeometry()
Defines the axes for logged vector quantities if they are not the global instrument axes
IDataset
getHigh_trip_value()
Upper control bound of sensor reading if using run_control
java.lang.Double
getHigh_trip_valueScalar()
Upper control bound of sensor reading if using run_control
IDataset
getLow_trip_value()
Lower control bound of sensor reading if using run_control
java.lang.Double
getLow_trip_valueScalar()
Lower control bound of sensor reading if using run_control
IDataset
getMeasurement()
name for measured signal
java.lang.String
getMeasurementScalar()
name for measured signal
IDataset
getModel()
Sensor identification code/model number
java.lang.String
getModelScalar()
Sensor identification code/model number
IDataset
getName()
Name for the sensor
java.lang.String
getNameScalar()
Name for the sensor
IDataset
getRun_control()
Is data collection controlled or synchronised to this quantity:
1=no, 0=to "value", 1=to "value_deriv1", etc.
java.lang.Boolean
getRun_controlScalar()
Is data collection controlled or synchronised to this quantity:
1=no, 0=to "value", 1=to "value_deriv1", etc.
IDataset
getShort_name()
Short name of sensor used e.g.
java.lang.String
getShort_nameScalar()
Short name of sensor used e.g.
IDataset
getType()
The type of hardware used for the measurement.
java.lang.String
getTypeScalar()
The type of hardware used for the measurement.
NXlog
getValue_deriv1_log()
Time history of first derivative of sensor readings
IDataset
getValue_deriv1()
Nominal/average first derivative of value
e.g.
java.lang.Double
getValue_deriv1Scalar()
Nominal/average first derivative of value
e.g.
NXlog
getValue_deriv2_log()
Time history of second derivative of sensor readings
IDataset
getValue_deriv2()
Nominal/average second derivative of value
- same dimensions as "value" (may be a vector)
java.lang.Double
getValue_deriv2Scalar()
Nominal/average second derivative of value
- same dimensions as "value" (may be a vector)
NXlog
getValue_log()
Time history of sensor readings
IDataset
getValue()
nominal setpoint or average value
- need [n] as may be a vector
java.lang.Double
getValueScalar()
nominal setpoint or average value
- need [n] as may be a vector
DataNode
setAttached_to(IDataset attached_to)
where sensor is attached to ("sample" | "can")
DataNode
setAttached_toScalar(java.lang.String attached_to)
where sensor is attached to ("sample" | "can")
DataNode
setExternal_field_brief(IDataset external_field_brief)
DataNode
setExternal_field_briefScalar(java.lang.String external_field_brief)
void
setExternal_field_full(NXorientation external_field_full)
For complex external fields not satisfied by External_field_brief
void
setGeometry(NXgeometry geometry)
Defines the axes for logged vector quantities if they are not the global instrument axes
DataNode
setHigh_trip_value(IDataset high_trip_value)
Upper control bound of sensor reading if using run_control
DataNode
setHigh_trip_valueScalar(java.lang.Double high_trip_value)
Upper control bound of sensor reading if using run_control
DataNode
setLow_trip_value(IDataset low_trip_value)
Lower control bound of sensor reading if using run_control
DataNode
setLow_trip_valueScalar(java.lang.Double low_trip_value)
Lower control bound of sensor reading if using run_control
DataNode
setMeasurement(IDataset measurement)
name for measured signal
DataNode
setMeasurementScalar(java.lang.String measurement)
name for measured signal
DataNode
setModel(IDataset model)
Sensor identification code/model number
DataNode
setModelScalar(java.lang.String model)
Sensor identification code/model number
DataNode
setName(IDataset name)
Name for the sensor
DataNode
setNameScalar(java.lang.String name)
Name for the sensor
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.
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.
DataNode
setShort_name(IDataset short_name)
Short name of sensor used e.g.
DataNode
setShort_nameScalar(java.lang.String short_name)
Short name of sensor used e.g.
DataNode
setType(IDataset type)
The type of hardware used for the measurement.
DataNode
setTypeScalar(java.lang.String type)
The type of hardware used for the measurement.
void
setValue_deriv1_log(NXlog value_deriv1_log)
Time history of first derivative of sensor readings
DataNode
setValue_deriv1(IDataset value_deriv1)
Nominal/average first derivative of value
e.g.
DataNode
setValue_deriv1Scalar(java.lang.Double value_deriv1)
Nominal/average first derivative of value
e.g.
void
setValue_deriv2_log(NXlog value_deriv2_log)
Time history of second derivative of sensor readings
DataNode
setValue_deriv2(IDataset value_deriv2)
Nominal/average second derivative of value
- same dimensions as "value" (may be a vector)
DataNode
setValue_deriv2Scalar(java.lang.Double value_deriv2)
Nominal/average second derivative of value
- same dimensions as "value" (may be a vector)
void
setValue_log(NXlog value_log)
Time history of sensor readings
DataNode
setValue(IDataset value)
nominal setpoint or average value
- need [n] as may be a vector
DataNode
setValueScalar(java.lang.Double value)
nominal setpoint or average value
- need [n] as may be a vector
-
Methods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNexusBaseClass, getNumber, getNXclass, getPermittedChildGroupClasses, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setField
-
Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool
-
Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode
-
-
Field Detail
-
NX_MODEL
static final java.lang.String NX_MODEL
- See Also:
- Constant Field Values
-
NX_NAME
static final java.lang.String NX_NAME
- See Also:
- Constant Field Values
-
NX_SHORT_NAME
static final java.lang.String NX_SHORT_NAME
- See Also:
- Constant Field Values
-
NX_ATTACHED_TO
static final java.lang.String NX_ATTACHED_TO
- See Also:
- Constant Field Values
-
NX_MEASUREMENT
static final java.lang.String NX_MEASUREMENT
- See Also:
- Constant Field Values
-
NX_TYPE
static final java.lang.String NX_TYPE
- See Also:
- Constant Field Values
-
NX_RUN_CONTROL
static final java.lang.String NX_RUN_CONTROL
- See Also:
- Constant Field Values
-
NX_HIGH_TRIP_VALUE
static final java.lang.String NX_HIGH_TRIP_VALUE
- See Also:
- Constant Field Values
-
NX_LOW_TRIP_VALUE
static final java.lang.String NX_LOW_TRIP_VALUE
- See Also:
- Constant Field Values
-
NX_VALUE
static final java.lang.String NX_VALUE
- See Also:
- Constant Field Values
-
NX_VALUE_DERIV1
static final java.lang.String NX_VALUE_DERIV1
- See Also:
- Constant Field Values
-
NX_VALUE_DERIV2
static final java.lang.String NX_VALUE_DERIV2
- See Also:
- Constant Field Values
-
NX_EXTERNAL_FIELD_BRIEF
static final java.lang.String NX_EXTERNAL_FIELD_BRIEF
- See Also:
- Constant Field Values
-
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