Package org.eclipse.dawnsci.nexus
Interface NXparameters
- All Known Subinterfaces:
NXapm_paraprobe_tool_parameters,NXmatch_filter,NXmicrostructure_mtex_config,NXspatial_filter,NXsubsampling_filter
Container for parameters, usually used in processing or analysis.
-
Field Summary
FieldsFields inherited from interface org.eclipse.dawnsci.nexus.NXobject
NX_ATTRIBUTE_DEFAULT -
Method Summary
Modifier and TypeMethodDescriptionGet all Parameter fields: A parameter (also known as a term) that is used in or results from processing.org.eclipse.january.dataset.DatasetgetParameter(String parameter) A parameter (also known as a term) that is used in or results from processing.getParameterAttributeUnits(String parameter) getParameterScalar(String parameter) A parameter (also known as a term) that is used in or results from processing.setParameter(String parameter, org.eclipse.january.dataset.IDataset parameterDataset) A parameter (also known as a term) that is used in or results from processing.voidsetParameterAttributeUnits(String parameter, String unitsValue) setParameterScalar(String parameter, Object parameterValue) A parameter (also known as a term) that is used in or results from processing.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_PARAMETER
- See Also:
-
NX_PARAMETER_ATTRIBUTE_UNITS
- See Also:
-
-
Method Details
-
getParameter
A parameter (also known as a term) that is used in or results from processing.Type: NX_CHAR_OR_NUMBER Units: NX_ANY
- Parameters:
parameter- the parameter- Returns:
- the value.
-
setParameter
A parameter (also known as a term) that is used in or results from processing.Type: NX_CHAR_OR_NUMBER Units: NX_ANY
- Parameters:
parameter- the parameterparameterDataset- the parameterDataset
-
getParameterScalar
A parameter (also known as a term) that is used in or results from processing.Type: NX_CHAR_OR_NUMBER Units: NX_ANY
- Parameters:
parameter- the parameter- Returns:
- the value.
-
setParameterScalar
A parameter (also known as a term) that is used in or results from processing.Type: NX_CHAR_OR_NUMBER Units: NX_ANY
- Parameters:
parameter- the parameterparameter- the parameter
-
getAllParameter
Get all Parameter fields: A parameter (also known as a term) that is used in or results from processing.Type: NX_CHAR_OR_NUMBER Units: NX_ANY
Note: this method returns ALL datasets within this group.
- Returns:
- a map from node names to the ? extends IDataset for that node.
-
getParameterAttributeUnits
- Parameters:
parameter- the parameter- Returns:
- the value.
-
setParameterAttributeUnits
- Parameters:
parameter- the parameterunitsValue- the unitsValue
-