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






NXparameters (h5jan API)











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
Interface NXparameters






All Superinterfaces:
GroupNode, java.lang.Iterable<NodeLink>, Node, NXobject


All Known Implementing Classes:
NXparametersImpl




public interface NXparameters
extends NXobject
Container for parameters, usually used in processing or analysis.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_TERM 


static java.lang.String
NX_TERM_ATTRIBUTE_UNITS 






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








Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


IDataset
getTerm()
A parameter (also known as a term) that is used in or results from processing.



java.lang.String
getTermAttributeUnits() 


java.lang.String
getTermScalar()
A parameter (also known as a term) that is used in or results from processing.



DataNode
setTerm(IDataset term)
A parameter (also known as a term) that is used in or results from processing.



void
setTermAttributeUnits(java.lang.String units) 


DataNode
setTermScalar(java.lang.String term)
A parameter (also known as a term) that is used in or results from processing.







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





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














Field Detail





NX_TERM
static final java.lang.String NX_TERM

See Also:
Constant Field Values








NX_TERM_ATTRIBUTE_UNITS
static final java.lang.String NX_TERM_ATTRIBUTE_UNITS

See Also:
Constant Field Values










Method Detail





getTerm
IDataset getTerm()
A parameter (also known as a term) that is used in or results from processing.
 
 Type: NX_CHAR
 

Returns:
the value.








setTerm
DataNode setTerm(IDataset term)
A parameter (also known as a term) that is used in or results from processing.
 
 Type: NX_CHAR
 

Parameters:
term - the term








getTermScalar
java.lang.String getTermScalar()
A parameter (also known as a term) that is used in or results from processing.
 
 Type: NX_CHAR
 

Returns:
the value.








setTermScalar
DataNode setTermScalar(java.lang.String term)
A parameter (also known as a term) that is used in or results from processing.
 
 Type: NX_CHAR
 

Parameters:
term - the term








getTermAttributeUnits
java.lang.String getTermAttributeUnits()

Returns:
the value.








setTermAttributeUnits
void setTermAttributeUnits(java.lang.String units)

Parameters:
units - the units














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

Modifier and Type	Field and Description
`static java.lang.String`	`NX_TERM`
`static java.lang.String`	`NX_TERM_ATTRIBUTE_UNITS`

Modifier and Type	Method and Description
`IDataset`	`getTerm()` A parameter (also known as a term) that is used in or results from processing.
`java.lang.String`	`getTermAttributeUnits()`
`java.lang.String`	`getTermScalar()` A parameter (also known as a term) that is used in or results from processing.
`DataNode`	`setTerm(IDataset term)` A parameter (also known as a term) that is used in or results from processing.
`void`	`setTermAttributeUnits(java.lang.String units)`
`DataNode`	`setTermScalar(java.lang.String term)` A parameter (also known as a term) that is used in or results from processing.