Package org.eclipse.dawnsci.nexus
Interface NXenvironment
Parameters for controlling external conditions
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringFields inherited from interface org.eclipse.dawnsci.nexus.NXobject
NX_ATTRIBUTE_DEFAULT -
Method Summary
Modifier and TypeMethodDescriptionAny actuator used to control the environment.getActuator(String name) Get a NXactuator node by name: Any actuator used to control the environment.Get all NXactuator nodes: Any actuator used to control the environment.Get all NXnote nodes: Additional information, LabView logs, digital photographs, etcGet all NXsensor nodes: Any sensor used to monitor the environment.Get all NXtransformations nodes: This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument.org.eclipse.january.dataset.DatasetNeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0.NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0.org.eclipse.january.dataset.DatasetDescription of the apparatus; e.g.Description of the apparatus; e.g.org.eclipse.january.dataset.DatasetgetName()Apparatus identification code/model number; e.g.Apparatus identification code/model number; e.g.getNote()Additional information, LabView logs, digital photographs, etcGet a NXnote node by name: Additional information, LabView logs, digital photographs, etcThe position and orientation of the apparatus.org.eclipse.january.dataset.DatasetProgram controlling the apparatus; e.g.Program controlling the apparatus; e.g.Any sensor used to monitor the environment.Get a NXsensor node by name: Any sensor used to monitor the environment.org.eclipse.january.dataset.DatasetAlternative short name, perhaps for dashboard display like a present Seblock nameAlternative short name, perhaps for dashboard display like a present Seblock nameThis is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument.getTransformations(String name) Get a NXtransformations node by name: This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument.org.eclipse.january.dataset.DatasetgetType()Type of apparatus.Type of apparatus.org.eclipse.january.dataset.DatasetgetValue()This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it.This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it.voidsetActuator(String name, NXactuator actuator) Set a NXactuator node by name: Any actuator used to control the environment.voidsetActuator(NXactuator actuatorGroup) Any actuator used to control the environment.voidsetAllActuator(Map<String, NXactuator> actuator) Set multiple child nodes of a particular type.voidsetAllNote(Map<String, NXnote> note) Set multiple child nodes of a particular type.voidsetAllSensor(Map<String, NXsensor> sensor) Set multiple child nodes of a particular type.voidsetAllTransformations(Map<String, NXtransformations> transformations) Set multiple child nodes of a particular type.setDepends_on(org.eclipse.january.dataset.IDataset depends_onDataset) NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0.setDepends_onScalar(String depends_onValue) NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0.setDescription(org.eclipse.january.dataset.IDataset descriptionDataset) Description of the apparatus; e.g.setDescriptionScalar(String descriptionValue) Description of the apparatus; e.g.setName(org.eclipse.january.dataset.IDataset nameDataset) Apparatus identification code/model number; e.g.setNameScalar(String nameValue) Apparatus identification code/model number; e.g.voidSet a NXnote node by name: Additional information, LabView logs, digital photographs, etcvoidAdditional information, LabView logs, digital photographs, etcvoidsetPosition(NXgeometry positionGroup) The position and orientation of the apparatus.setProgram(org.eclipse.january.dataset.IDataset programDataset) Program controlling the apparatus; e.g.setProgramScalar(String programValue) Program controlling the apparatus; e.g.voidSet a NXsensor node by name: Any sensor used to monitor the environment.voidAny sensor used to monitor the environment.setShort_name(org.eclipse.january.dataset.IDataset short_nameDataset) Alternative short name, perhaps for dashboard display like a present Seblock namesetShort_nameScalar(String short_nameValue) Alternative short name, perhaps for dashboard display like a present Seblock namevoidsetTransformations(String name, NXtransformations transformations) Set a NXtransformations node by name: This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument.voidsetTransformations(NXtransformations transformationsGroup) This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument.setType(org.eclipse.january.dataset.IDataset typeDataset) Type of apparatus.setTypeScalar(String typeValue) Type of apparatus.setValue(org.eclipse.january.dataset.IDataset valueDataset) This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it.setValueScalar(Double valueValue) This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it.Methods inherited from interface org.eclipse.dawnsci.analysis.api.tree.GroupNode
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, findLinkedNodeName, findNode, findNodeLink, getDataNode, getDataNodeMap, getDataNodeNames, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodeNames, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, getSymbolicNodeNames, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPoolMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.eclipse.dawnsci.analysis.api.tree.Node
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getAttributeNames, getID, getNumberOfAttributes, isDataNode, isGroupNode, isSymbolicNode, removeAttribute, removeAttributeMethods inherited from interface org.eclipse.dawnsci.nexus.NXobject
addExternalLink, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttributeDefault, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyDataset, getLazyWritableDataset, getLong, getNexusBaseClass, getNumber, getNXclass, getPermittedChildGroupClasses, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setAttributeDefault, setChildren, setDataset, setField
-
Field Details
-
NX_NAME
- See Also:
-
NX_SHORT_NAME
- See Also:
-
NX_TYPE
- See Also:
-
NX_DESCRIPTION
- See Also:
-
NX_PROGRAM
- See Also:
-
NX_VALUE
- See Also:
-
NX_DEPENDS_ON
- See Also:
-
-
Method Details
-
getName
org.eclipse.january.dataset.Dataset getName()Apparatus identification code/model number; e.g. OC100 011- Returns:
- the value.
-
setName
Apparatus identification code/model number; e.g. OC100 011- Parameters:
nameDataset- the nameDataset
-
getNameScalar
String getNameScalar()Apparatus identification code/model number; e.g. OC100 011- Returns:
- the value.
-
setNameScalar
Apparatus identification code/model number; e.g. OC100 011- Parameters:
name- the name
-
getShort_name
org.eclipse.january.dataset.Dataset getShort_name()Alternative short name, perhaps for dashboard display like a present Seblock name- Returns:
- the value.
-
setShort_name
Alternative short name, perhaps for dashboard display like a present Seblock name- Parameters:
short_nameDataset- the short_nameDataset
-
getShort_nameScalar
String getShort_nameScalar()Alternative short name, perhaps for dashboard display like a present Seblock name- Returns:
- the value.
-
setShort_nameScalar
Alternative short name, perhaps for dashboard display like a present Seblock name- Parameters:
short_name- the short_name
-
getType
org.eclipse.january.dataset.Dataset getType()Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100- Returns:
- the value.
-
setType
Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100- Parameters:
typeDataset- the typeDataset
-
getTypeScalar
String getTypeScalar()Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100- Returns:
- the value.
-
setTypeScalar
Type of apparatus. This could be the SE codes in scheduling database; e.g. OC/100- Parameters:
type- the type
-
getDescription
org.eclipse.january.dataset.Dataset getDescription()Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump- Returns:
- the value.
-
setDescription
Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump- Parameters:
descriptionDataset- the descriptionDataset
-
getDescriptionScalar
String getDescriptionScalar()Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump- Returns:
- the value.
-
setDescriptionScalar
Description of the apparatus; e.g. 100mm bore orange cryostat with Roots pump- Parameters:
description- the description
-
getProgram
org.eclipse.january.dataset.Dataset getProgram()Program controlling the apparatus; e.g. LabView VI name- Returns:
- the value.
-
setProgram
Program controlling the apparatus; e.g. LabView VI name- Parameters:
programDataset- the programDataset
-
getProgramScalar
String getProgramScalar()Program controlling the apparatus; e.g. LabView VI name- Returns:
- the value.
-
setProgramScalar
Program controlling the apparatus; e.g. LabView VI name- Parameters:
program- the program
-
getPosition
NXgeometry getPosition()The position and orientation of the apparatus. Note, it is recommended to use NXtransformations instead.- Returns:
- the value.
-
setPosition
The position and orientation of the apparatus. Note, it is recommended to use NXtransformations instead.- Parameters:
positionGroup- the positionGroup
-
getValue
org.eclipse.january.dataset.Dataset getValue()This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it. An example would be a room temperature experiment where the temperature is not actively measured, but rather estimated. Note that this method for recording the environment parameters is not advised, but using NXsensor and NXactuator is strongly recommended instead.Type: NX_FLOAT Units: NX_ANY
- Returns:
- the value.
-
setValue
This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it. An example would be a room temperature experiment where the temperature is not actively measured, but rather estimated. Note that this method for recording the environment parameters is not advised, but using NXsensor and NXactuator is strongly recommended instead.Type: NX_FLOAT Units: NX_ANY
- Parameters:
valueDataset- the valueDataset
-
getValueScalar
Double getValueScalar()This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it. An example would be a room temperature experiment where the temperature is not actively measured, but rather estimated. Note that this method for recording the environment parameters is not advised, but using NXsensor and NXactuator is strongly recommended instead.Type: NX_FLOAT Units: NX_ANY
- Returns:
- the value.
-
setValueScalar
This is to be used if there is no actuator/sensor that controls/measures the environment parameters, but the user would still like to give a value for it. An example would be a room temperature experiment where the temperature is not actively measured, but rather estimated. Note that this method for recording the environment parameters is not advised, but using NXsensor and NXactuator is strongly recommended instead.Type: NX_FLOAT Units: NX_ANY
- Parameters:
value- the value
-
getDepends_on
org.eclipse.january.dataset.Dataset getDepends_on()NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere.Type: NX_CHAR
- Returns:
- the value.
-
setDepends_on
NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere.Type: NX_CHAR
- Parameters:
depends_onDataset- the depends_onDataset
-
getDepends_onScalar
String getDepends_onScalar()NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere.Type: NX_CHAR
- Returns:
- the value.
-
setDepends_onScalar
NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere.Type: NX_CHAR
- Parameters:
depends_on- the depends_on
-
getTransformations
NXtransformations getTransformations()This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.- Returns:
- the value.
-
setTransformations
This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.- Parameters:
transformationsGroup- the transformationsGroup
-
getTransformations
Get a NXtransformations node by name:- This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.
- Parameters:
name- the name of the node.- Returns:
- a map from node names to the NXtransformations for that node.
-
setTransformations
Set a NXtransformations node by name:- This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.
- Parameters:
name- the name of the nodetransformations- the value to set
-
getAllTransformations
Map<String,NXtransformations> getAllTransformations()Get all NXtransformations nodes:- This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.
- Returns:
- a map from node names to the NXtransformations for that node.
-
setAllTransformations
Set multiple child nodes of a particular type.- This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups.
- Parameters:
transformations- the child nodes to add
-
getNote
NXnote getNote()Additional information, LabView logs, digital photographs, etc- Returns:
- the value.
-
setNote
Additional information, LabView logs, digital photographs, etc- Parameters:
noteGroup- the noteGroup
-
getNote
Get a NXnote node by name:- Additional information, LabView logs, digital photographs, etc
- Parameters:
name- the name of the node.- Returns:
- a map from node names to the NXnote for that node.
-
setNote
Set a NXnote node by name:- Additional information, LabView logs, digital photographs, etc
- Parameters:
name- the name of the nodenote- the value to set
-
getAllNote
Get all NXnote nodes:- Additional information, LabView logs, digital photographs, etc
- Returns:
- a map from node names to the NXnote for that node.
-
setAllNote
Set multiple child nodes of a particular type.- Additional information, LabView logs, digital photographs, etc
- Parameters:
note- the child nodes to add
-
getActuator
NXactuator getActuator()Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.- Returns:
- the value.
-
setActuator
Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.- Parameters:
actuatorGroup- the actuatorGroup
-
getActuator
Get a NXactuator node by name:- Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.
- Parameters:
name- the name of the node.- Returns:
- a map from node names to the NXactuator for that node.
-
setActuator
Set a NXactuator node by name:- Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.
- Parameters:
name- the name of the nodeactuator- the value to set
-
getAllActuator
Map<String,NXactuator> getAllActuator()Get all NXactuator nodes:- Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.
- Returns:
- a map from node names to the NXactuator for that node.
-
setAllActuator
Set multiple child nodes of a particular type.- Any actuator used to control the environment. This can be linked to an actuator defined in an NXinstrument instance.
- Parameters:
actuator- the child nodes to add
-
getSensor
NXsensor getSensor()Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.- Returns:
- the value.
-
setSensor
Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.- Parameters:
sensorGroup- the sensorGroup
-
getSensor
Get a NXsensor node by name:- Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.
- Parameters:
name- the name of the node.- Returns:
- a map from node names to the NXsensor for that node.
-
setSensor
Set a NXsensor node by name:- Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.
- Parameters:
name- the name of the nodesensor- the value to set
-
getAllSensor
Get all NXsensor nodes:- Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.
- Returns:
- a map from node names to the NXsensor for that node.
-
setAllSensor
Set multiple child nodes of a particular type.- Any sensor used to monitor the environment. This can be linked to a sensor defined in an NXinstrument instance.
- Parameters:
sensor- the child nodes to add
-