Package org.eclipse.dawnsci.nexus
Interface NXhistory
A set of activities that occurred to a physical entity prior/during experiment.
Ideally, a full report of the previous operations (or links to a chain of operations).
Alternatively, notes allow for additional descriptors in any format.
-
Field Summary
FieldsFields inherited from interface org.eclipse.dawnsci.nexus.NXobject
NX_ATTRIBUTE_DEFAULT -
Method Summary
Modifier and TypeMethodDescriptionAny activity that was performed on the physical entity prior or during the experiment.getActivity(String name) Get a NXactivity node by name: Any activity that was performed on the physical entity prior or during the experiment.Get all NXactivity nodes: Any activity that was performed on the physical entity prior or during the experiment.Get all NXnote nodes: A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies).org.eclipse.january.dataset.DatasetAn ID or reference to the location or a unique (globally persistent) identifier of e.g.An ID or reference to the location or a unique (globally persistent) identifier of e.g.getNote()A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies).Get a NXnote node by name: A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies).voidsetActivity(String name, NXactivity activity) Set a NXactivity node by name: Any activity that was performed on the physical entity prior or during the experiment.voidsetActivity(NXactivity activityGroup) Any activity that was performed on the physical entity prior or during the experiment.voidsetAllActivity(Map<String, NXactivity> activity) Set multiple child nodes of a particular type.voidsetAllNote(Map<String, NXnote> note) Set multiple child nodes of a particular type.setIdentifiername(org.eclipse.january.dataset.IDataset identifiernameDataset) An ID or reference to the location or a unique (globally persistent) identifier of e.g.setIdentifiernameScalar(String identifiernameValue) An ID or reference to the location or a unique (globally persistent) identifier of e.g.voidSet a NXnote node by name: A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies).voidA descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies).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_IDENTIFIERNAME
- See Also:
-
-
Method Details
-
getActivity
NXactivity getActivity()Any activity that was performed on the physical entity prior or during the experiment.- Returns:
- the value.
-
setActivity
Any activity that was performed on the physical entity prior or during the experiment.- Parameters:
activityGroup- the activityGroup
-
getActivity
Get a NXactivity node by name:- Any activity that was performed on the physical entity prior or during the experiment.
- Parameters:
name- the name of the node.- Returns:
- a map from node names to the NXactivity for that node.
-
setActivity
Set a NXactivity node by name:- Any activity that was performed on the physical entity prior or during the experiment.
- Parameters:
name- the name of the nodeactivity- the value to set
-
getAllActivity
Map<String,NXactivity> getAllActivity()Get all NXactivity nodes:- Any activity that was performed on the physical entity prior or during the experiment.
- Returns:
- a map from node names to the NXactivity for that node.
-
setAllActivity
Set multiple child nodes of a particular type.- Any activity that was performed on the physical entity prior or during the experiment.
- Parameters:
activity- the child nodes to add
-
getIdentifiername
org.eclipse.january.dataset.Dataset getIdentifiername()An ID or reference to the location or a unique (globally persistent) identifier of e.g. another file which gives as many as possible details of the history event.- Returns:
- the value.
-
setIdentifiername
An ID or reference to the location or a unique (globally persistent) identifier of e.g. another file which gives as many as possible details of the history event.- Parameters:
identifiernameDataset- the identifiernameDataset
-
getIdentifiernameScalar
String getIdentifiernameScalar()An ID or reference to the location or a unique (globally persistent) identifier of e.g. another file which gives as many as possible details of the history event.- Returns:
- the value.
-
setIdentifiernameScalar
An ID or reference to the location or a unique (globally persistent) identifier of e.g. another file which gives as many as possible details of the history event.- Parameters:
identifiername- the identifiername
-
getNote
NXnote getNote()A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.- Returns:
- the value.
-
setNote
A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.- Parameters:
noteGroup- the noteGroup
-
getNote
Get a NXnote node by name:- A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.
- 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:- A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.
- Parameters:
name- the name of the nodenote- the value to set
-
getAllNote
Get all NXnote nodes:- A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.
- Returns:
- a map from node names to the NXnote for that node.
-
setAllNote
Set multiple child nodes of a particular type.- A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.
- Parameters:
note- the child nodes to add
-