• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXsensorImpl.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.eclipse.dawnsci.nexus.impl
Class NXsensorImpl



java.lang.Object


org.eclipse.dawnsci.analysis.tree.impl.NodeImpl


org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl


org.eclipse.dawnsci.nexus.impl.NXobjectImpl


org.eclipse.dawnsci.nexus.impl.NXsensorImpl













All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXobject, NXsensor




public class NXsensorImpl
extends NXobjectImpl
implements NXsensor
A sensor used to monitor an external condition
 The condition itself is described in :ref:`NXenvironment`.

See Also:
Serialized Form












Field Summary

Fields 

Modifier and Type
Field and Description


static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES 






Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS





Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT





Fields inherited from interface org.eclipse.dawnsci.nexus.NXsensor
NX_ATTACHED_TO, NX_EXTERNAL_FIELD_BRIEF, NX_HIGH_TRIP_VALUE, NX_LOW_TRIP_VALUE, NX_MEASUREMENT, NX_MODEL, NX_NAME, NX_RUN_CONTROL, NX_SHORT_NAME, NX_TYPE, NX_VALUE, NX_VALUE_DERIV1, NX_VALUE_DERIV2





Fields inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
ATTRIBUTE, SEPARATOR








Constructor Summary

Constructors 

Constructor and Description


NXsensorImpl() 


NXsensorImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete 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



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



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 class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, createNodeLink, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isGroupNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool, toString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait





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, getNumber, 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





Methods inherited from interface java.lang.Iterable
forEach, spliterator














Field Detail





PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES









Constructor Detail





NXsensorImpl
public NXsensorImpl()







NXsensorImpl
public NXsensorImpl(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








getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass for this base class, e.g. NexusBaseClass.NX_SAMPLE.

Specified by:
getNexusBaseClass in interface NXobject
Returns:
NexusBaseClass enum constant for this class








getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.

Specified by:
getPermittedChildGroupClasses in interface NXobject
Returns:
NexusBaseClass constants for permitted child groups








getModel
public IDataset getModel()
Description copied from interface: NXsensor
Sensor identification code/model number

Specified by:
getModel in interface NXsensor
Returns:
the value.








getModelScalar
public java.lang.String getModelScalar()
Description copied from interface: NXsensor
Sensor identification code/model number

Specified by:
getModelScalar in interface NXsensor
Returns:
the value.








setModel
public DataNode setModel(IDataset model)
Description copied from interface: NXsensor
Sensor identification code/model number

Specified by:
setModel in interface NXsensor
Parameters:
model - the model








setModelScalar
public DataNode setModelScalar(java.lang.String model)
Description copied from interface: NXsensor
Sensor identification code/model number

Specified by:
setModelScalar in interface NXsensor
Parameters:
model - the model








getName
public IDataset getName()
Description copied from interface: NXsensor
Name for the sensor

Specified by:
getName in interface NXsensor
Returns:
the value.








getNameScalar
public java.lang.String getNameScalar()
Description copied from interface: NXsensor
Name for the sensor

Specified by:
getNameScalar in interface NXsensor
Returns:
the value.








setName
public DataNode setName(IDataset name)
Description copied from interface: NXsensor
Name for the sensor

Specified by:
setName in interface NXsensor
Parameters:
name - the name








setNameScalar
public DataNode setNameScalar(java.lang.String name)
Description copied from interface: NXsensor
Name for the sensor

Specified by:
setNameScalar in interface NXsensor
Parameters:
name - the name








getShort_name
public IDataset getShort_name()
Description copied from interface: NXsensor
Short name of sensor used e.g. on monitor display program

Specified by:
getShort_name in interface NXsensor
Returns:
the value.








getShort_nameScalar
public java.lang.String getShort_nameScalar()
Description copied from interface: NXsensor
Short name of sensor used e.g. on monitor display program

Specified by:
getShort_nameScalar in interface NXsensor
Returns:
the value.








setShort_name
public DataNode setShort_name(IDataset short_name)
Description copied from interface: NXsensor
Short name of sensor used e.g. on monitor display program

Specified by:
setShort_name in interface NXsensor
Parameters:
short_name - the short_name








setShort_nameScalar
public DataNode setShort_nameScalar(java.lang.String short_name)
Description copied from interface: NXsensor
Short name of sensor used e.g. on monitor display program

Specified by:
setShort_nameScalar in interface NXsensor
Parameters:
short_name - the short_name








getAttached_to
public IDataset getAttached_to()
Description copied from interface: NXsensor
where sensor is attached to ("sample" | "can")

Specified by:
getAttached_to in interface NXsensor
Returns:
the value.








getAttached_toScalar
public java.lang.String getAttached_toScalar()
Description copied from interface: NXsensor
where sensor is attached to ("sample" | "can")

Specified by:
getAttached_toScalar in interface NXsensor
Returns:
the value.








setAttached_to
public DataNode setAttached_to(IDataset attached_to)
Description copied from interface: NXsensor
where sensor is attached to ("sample" | "can")

Specified by:
setAttached_to in interface NXsensor
Parameters:
attached_to - the attached_to








setAttached_toScalar
public DataNode setAttached_toScalar(java.lang.String attached_to)
Description copied from interface: NXsensor
where sensor is attached to ("sample" | "can")

Specified by:
setAttached_toScalar in interface NXsensor
Parameters:
attached_to - the attached_to








getGeometry
public NXgeometry getGeometry()
Description copied from interface: NXsensor
Defines the axes for logged vector quantities if they are not the global instrument axes

Specified by:
getGeometry in interface NXsensor
Returns:
the value.








setGeometry
public void setGeometry(NXgeometry geometry)
Description copied from interface: NXsensor
Defines the axes for logged vector quantities if they are not the global instrument axes

Specified by:
setGeometry in interface NXsensor
Parameters:
geometry - the geometry








getMeasurement
public IDataset getMeasurement()
Description copied from interface: NXsensor
name for measured signal
 

 
Enumeration:

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

 


Specified by:
getMeasurement in interface NXsensor
Returns:
the value.








getMeasurementScalar
public java.lang.String getMeasurementScalar()
Description copied from interface: NXsensor
name for measured signal
 

 
Enumeration:

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

 


Specified by:
getMeasurementScalar in interface NXsensor
Returns:
the value.








setMeasurement
public DataNode setMeasurement(IDataset measurement)
Description copied from interface: NXsensor
name for measured signal
 

 
Enumeration:

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

 


Specified by:
setMeasurement in interface NXsensor
Parameters:
measurement - the measurement








setMeasurementScalar
public DataNode setMeasurementScalar(java.lang.String measurement)
Description copied from interface: NXsensor
name for measured signal
 

 
Enumeration:

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

 


Specified by:
setMeasurementScalar in interface NXsensor
Parameters:
measurement - the measurement








getType
public IDataset getType()
Description copied from interface: NXsensor
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

Specified by:
getType in interface NXsensor
Returns:
the value.








getTypeScalar
public java.lang.String getTypeScalar()
Description copied from interface: NXsensor
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

Specified by:
getTypeScalar in interface NXsensor
Returns:
the value.








setType
public DataNode setType(IDataset type)
Description copied from interface: NXsensor
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

Specified by:
setType in interface NXsensor
Parameters:
type - the type








setTypeScalar
public DataNode setTypeScalar(java.lang.String type)
Description copied from interface: NXsensor
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

Specified by:
setTypeScalar in interface NXsensor
Parameters:
type - the type








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

 Type: NX_BOOLEAN
 

Specified by:
getRun_control in interface NXsensor
Returns:
the value.








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

 Type: NX_BOOLEAN
 

Specified by:
getRun_controlScalar in interface NXsensor
Returns:
the value.








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

 Type: NX_BOOLEAN
 

Specified by:
setRun_control in interface NXsensor
Parameters:
run_control - the run_control








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

 Type: NX_BOOLEAN
 

Specified by:
setRun_controlScalar in interface NXsensor
Parameters:
run_control - the run_control








getHigh_trip_value
public IDataset getHigh_trip_value()
Description copied from interface: NXsensor
Upper control bound of sensor reading if using run_control
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
getHigh_trip_value in interface NXsensor
Returns:
the value.








getHigh_trip_valueScalar
public java.lang.Double getHigh_trip_valueScalar()
Description copied from interface: NXsensor
Upper control bound of sensor reading if using run_control
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
getHigh_trip_valueScalar in interface NXsensor
Returns:
the value.








setHigh_trip_value
public DataNode setHigh_trip_value(IDataset high_trip_value)
Description copied from interface: NXsensor
Upper control bound of sensor reading if using run_control
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
setHigh_trip_value in interface NXsensor
Parameters:
high_trip_value - the high_trip_value








setHigh_trip_valueScalar
public DataNode setHigh_trip_valueScalar(java.lang.Double high_trip_value)
Description copied from interface: NXsensor
Upper control bound of sensor reading if using run_control
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
setHigh_trip_valueScalar in interface NXsensor
Parameters:
high_trip_value - the high_trip_value








getLow_trip_value
public IDataset getLow_trip_value()
Description copied from interface: NXsensor
Lower control bound of sensor reading if using run_control
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
getLow_trip_value in interface NXsensor
Returns:
the value.








getLow_trip_valueScalar
public java.lang.Double getLow_trip_valueScalar()
Description copied from interface: NXsensor
Lower control bound of sensor reading if using run_control
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
getLow_trip_valueScalar in interface NXsensor
Returns:
the value.








setLow_trip_value
public DataNode setLow_trip_value(IDataset low_trip_value)
Description copied from interface: NXsensor
Lower control bound of sensor reading if using run_control
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
setLow_trip_value in interface NXsensor
Parameters:
low_trip_value - the low_trip_value








setLow_trip_valueScalar
public DataNode setLow_trip_valueScalar(java.lang.Double low_trip_value)
Description copied from interface: NXsensor
Lower control bound of sensor reading if using run_control
 

 Type: NX_FLOAT
 Units: NX_ANY
 

Specified by:
setLow_trip_valueScalar in interface NXsensor
Parameters:
low_trip_value - the low_trip_value








getValue
public IDataset getValue()
Description copied from interface: NXsensor
nominal setpoint or average value
 - need [n] as may be a vector
 

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

Specified by:
getValue in interface NXsensor
Returns:
the value.








getValueScalar
public java.lang.Double getValueScalar()
Description copied from interface: NXsensor
nominal setpoint or average value
 - need [n] as may be a vector
 

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

Specified by:
getValueScalar in interface NXsensor
Returns:
the value.








setValue
public DataNode setValue(IDataset value)
Description copied from interface: NXsensor
nominal setpoint or average value
 - need [n] as may be a vector
 

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

Specified by:
setValue in interface NXsensor
Parameters:
value - the value








setValueScalar
public DataNode setValueScalar(java.lang.Double value)
Description copied from interface: NXsensor
nominal setpoint or average value
 - need [n] as may be a vector
 

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

Specified by:
setValueScalar in interface NXsensor
Parameters:
value - the value








getValue_deriv1
public IDataset getValue_deriv1()
Description copied from interface: NXsensor
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: ;
 

Specified by:
getValue_deriv1 in interface NXsensor
Returns:
the value.








getValue_deriv1Scalar
public java.lang.Double getValue_deriv1Scalar()
Description copied from interface: NXsensor
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: ;
 

Specified by:
getValue_deriv1Scalar in interface NXsensor
Returns:
the value.








setValue_deriv1
public DataNode setValue_deriv1(IDataset value_deriv1)
Description copied from interface: NXsensor
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: ;
 

Specified by:
setValue_deriv1 in interface NXsensor
Parameters:
value_deriv1 - the value_deriv1








setValue_deriv1Scalar
public DataNode setValue_deriv1Scalar(java.lang.Double value_deriv1)
Description copied from interface: NXsensor
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: ;
 

Specified by:
setValue_deriv1Scalar in interface NXsensor
Parameters:
value_deriv1 - the value_deriv1








getValue_deriv2
public IDataset getValue_deriv2()
Description copied from interface: NXsensor
Nominal/average second derivative of value
 - same dimensions as "value" (may be a vector)
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: ;
 

Specified by:
getValue_deriv2 in interface NXsensor
Returns:
the value.








getValue_deriv2Scalar
public java.lang.Double getValue_deriv2Scalar()
Description copied from interface: NXsensor
Nominal/average second derivative of value
 - same dimensions as "value" (may be a vector)
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: ;
 

Specified by:
getValue_deriv2Scalar in interface NXsensor
Returns:
the value.








setValue_deriv2
public DataNode setValue_deriv2(IDataset value_deriv2)
Description copied from interface: NXsensor
Nominal/average second derivative of value
 - same dimensions as "value" (may be a vector)
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: ;
 

Specified by:
setValue_deriv2 in interface NXsensor
Parameters:
value_deriv2 - the value_deriv2








setValue_deriv2Scalar
public DataNode setValue_deriv2Scalar(java.lang.Double value_deriv2)
Description copied from interface: NXsensor
Nominal/average second derivative of value
 - same dimensions as "value" (may be a vector)
 

 Type: NX_FLOAT
 Units: NX_ANY
 Dimensions: 1: ;
 

Specified by:
setValue_deriv2Scalar in interface NXsensor
Parameters:
value_deriv2 - the value_deriv2








getValue_log
public NXlog getValue_log()
Description copied from interface: NXsensor
Time history of sensor readings

Specified by:
getValue_log in interface NXsensor
Returns:
the value.








setValue_log
public void setValue_log(NXlog value_log)
Description copied from interface: NXsensor
Time history of sensor readings

Specified by:
setValue_log in interface NXsensor
Parameters:
value_log - the value_log








getValue_deriv1_log
public NXlog getValue_deriv1_log()
Description copied from interface: NXsensor
Time history of first derivative of sensor readings

Specified by:
getValue_deriv1_log in interface NXsensor
Returns:
the value.








setValue_deriv1_log
public void setValue_deriv1_log(NXlog value_deriv1_log)
Description copied from interface: NXsensor
Time history of first derivative of sensor readings

Specified by:
setValue_deriv1_log in interface NXsensor
Parameters:
value_deriv1_log - the value_deriv1_log








getValue_deriv2_log
public NXlog getValue_deriv2_log()
Description copied from interface: NXsensor
Time history of second derivative of sensor readings

Specified by:
getValue_deriv2_log in interface NXsensor
Returns:
the value.








setValue_deriv2_log
public void setValue_deriv2_log(NXlog value_deriv2_log)
Description copied from interface: NXsensor
Time history of second derivative of sensor readings

Specified by:
setValue_deriv2_log in interface NXsensor
Parameters:
value_deriv2_log - the value_deriv2_log








getExternal_field_brief
public IDataset getExternal_field_brief()
Description copied from interface: NXsensor

 
Enumeration:

 
along beam 
 
across beam 
 
transverse 
 
solenoidal 
 
flow shear gradient 
 
flow vorticity 

 


Specified by:
getExternal_field_brief in interface NXsensor
Returns:
the value.








getExternal_field_briefScalar
public java.lang.String getExternal_field_briefScalar()
Description copied from interface: NXsensor

 
Enumeration:

 
along beam 
 
across beam 
 
transverse 
 
solenoidal 
 
flow shear gradient 
 
flow vorticity 

 


Specified by:
getExternal_field_briefScalar in interface NXsensor
Returns:
the value.








setExternal_field_brief
public DataNode setExternal_field_brief(IDataset external_field_brief)
Description copied from interface: NXsensor

 
Enumeration:

 
along beam 
 
across beam 
 
transverse 
 
solenoidal 
 
flow shear gradient 
 
flow vorticity 

 


Specified by:
setExternal_field_brief in interface NXsensor
Parameters:
external_field_brief - the external_field_brief








setExternal_field_briefScalar
public DataNode setExternal_field_briefScalar(java.lang.String external_field_brief)
Description copied from interface: NXsensor

 
Enumeration:

 
along beam 
 
across beam 
 
transverse 
 
solenoidal 
 
flow shear gradient 
 
flow vorticity 

 


Specified by:
setExternal_field_briefScalar in interface NXsensor
Parameters:
external_field_brief - the external_field_brief








getExternal_field_full
public NXorientation getExternal_field_full()
Description copied from interface: NXsensor
For complex external fields not satisfied by External_field_brief

Specified by:
getExternal_field_full in interface NXsensor
Returns:
the value.








setExternal_field_full
public void setExternal_field_full(NXorientation external_field_full)
Description copied from interface: NXsensor
For complex external fields not satisfied by External_field_brief

Specified by:
setExternal_field_full in interface NXsensor
Parameters:
external_field_full - the external_field_full














Skip navigation links




Overview
Package
Class
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method