• Home
• io.github.h5jan
• h5jan-core
• 0.4.3
• source code
• NXprocess.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.NXprocess.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
Interface NXprocess






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


All Known Implementing Classes:
NXprocessImpl




public interface NXprocess
extends NXobject
Document an event of data processing, reconstruction, or analysis for this data.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_DATE 


static java.lang.String
NX_PROGRAM 


static java.lang.String
NX_SEQUENCE_INDEX 


static java.lang.String
NX_VERSION 






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


java.util.Map<java.lang.String,NXnote>
getAllNote()
Get all NXnote nodes:
 
 
 The note will contain information about how the data was processed
 or anything about the data provenance.



IDataset
getDate()
Date and time of processing.



java.util.Date
getDateScalar()
Date and time of processing.



NXnote
getNote()
The note will contain information about how the data was processed
 or anything about the data provenance.



NXnote
getNote(java.lang.String name)
Get a NXnote node by name:
 
 
 The note will contain information about how the data was processed
 or anything about the data provenance.



IDataset
getProgram()
Name of the program used



java.lang.String
getProgramScalar()
Name of the program used



IDataset
getSequence_index()
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.



java.lang.Long
getSequence_indexScalar()
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.



IDataset
getVersion()
Version of the program used



java.lang.String
getVersionScalar()
Version of the program used



void
setAllNote(java.util.Map<java.lang.String,NXnote> note)
Set multiple child nodes of a particular type.



DataNode
setDate(IDataset date)
Date and time of processing.



DataNode
setDateScalar(java.util.Date date)
Date and time of processing.



void
setNote(NXnote note)
The note will contain information about how the data was processed
 or anything about the data provenance.



void
setNote(java.lang.String name,
       NXnote note)
Set a NXnote node by name:
 
 
 The note will contain information about how the data was processed
 or anything about the data provenance.



DataNode
setProgram(IDataset program)
Name of the program used



DataNode
setProgramScalar(java.lang.String program)
Name of the program used



DataNode
setSequence_index(IDataset sequence_index)
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.



DataNode
setSequence_indexScalar(java.lang.Long sequence_index)
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.



DataNode
setVersion(IDataset version)
Version of the program used



DataNode
setVersionScalar(java.lang.String version)
Version of the program used







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_PROGRAM
static final java.lang.String NX_PROGRAM

See Also:
Constant Field Values








NX_SEQUENCE_INDEX
static final java.lang.String NX_SEQUENCE_INDEX

See Also:
Constant Field Values








NX_VERSION
static final java.lang.String NX_VERSION

See Also:
Constant Field Values








NX_DATE
static final java.lang.String NX_DATE

See Also:
Constant Field Values










Method Detail





getProgram
IDataset getProgram()
Name of the program used
 

 Type: NX_CHAR
 

Returns:
the value.








setProgram
DataNode setProgram(IDataset program)
Name of the program used
 

 Type: NX_CHAR
 

Parameters:
program - the program








getProgramScalar
java.lang.String getProgramScalar()
Name of the program used
 

 Type: NX_CHAR
 

Returns:
the value.








setProgramScalar
DataNode setProgramScalar(java.lang.String program)
Name of the program used
 

 Type: NX_CHAR
 

Parameters:
program - the program








getSequence_index
IDataset getSequence_index()
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.
 Starts with 1.
 

 Type: NX_POSINT
 

Returns:
the value.








setSequence_index
DataNode setSequence_index(IDataset sequence_index)
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.
 Starts with 1.
 

 Type: NX_POSINT
 

Parameters:
sequence_index - the sequence_index








getSequence_indexScalar
java.lang.Long getSequence_indexScalar()
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.
 Starts with 1.
 

 Type: NX_POSINT
 

Returns:
the value.








setSequence_indexScalar
DataNode setSequence_indexScalar(java.lang.Long sequence_index)
Sequence index of processing,
 for determining the order of multiple **NXprocess** steps.
 Starts with 1.
 

 Type: NX_POSINT
 

Parameters:
sequence_index - the sequence_index








getVersion
IDataset getVersion()
Version of the program used
 

 Type: NX_CHAR
 

Returns:
the value.








setVersion
DataNode setVersion(IDataset version)
Version of the program used
 

 Type: NX_CHAR
 

Parameters:
version - the version








getVersionScalar
java.lang.String getVersionScalar()
Version of the program used
 

 Type: NX_CHAR
 

Returns:
the value.








setVersionScalar
DataNode setVersionScalar(java.lang.String version)
Version of the program used
 

 Type: NX_CHAR
 

Parameters:
version - the version








getDate
IDataset getDate()
Date and time of processing.
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setDate
DataNode setDate(IDataset date)
Date and time of processing.
 

 Type: NX_DATE_TIME
 

Parameters:
date - the date








getDateScalar
java.util.Date getDateScalar()
Date and time of processing.
 

 Type: NX_DATE_TIME
 

Returns:
the value.








setDateScalar
DataNode setDateScalar(java.util.Date date)
Date and time of processing.
 

 Type: NX_DATE_TIME
 

Parameters:
date - the date








getNote
NXnote getNote()
The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.

Returns:
the value.








setNote
void setNote(NXnote note)
The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.

Parameters:
note - the note








getNote
NXnote getNote(java.lang.String name)
Get a NXnote node by name:
 

 

 The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.
 

Parameters:
name - the name of the node.
Returns:
a map from node names to the NXnote for that node.








setNote
void setNote(java.lang.String name,
             NXnote note)
Set a NXnote node by name:
 

 

 The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.
 

Parameters:
name - the name of the node
note - the value to set








getAllNote
java.util.Map<java.lang.String,NXnote> getAllNote()
Get all NXnote nodes:
 

 

 The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.
 

Returns:
a map from node names to the NXnote for that node.








setAllNote
void setAllNote(java.util.Map<java.lang.String,NXnote> note)
Set multiple child nodes of a particular type.
 

 

 The note will contain information about how the data was processed
 or anything about the data provenance.
 The contents of the note can be anything that the processing code
 can understand, or simple text.
 The name will be numbered to allow for ordering of steps.
 

Parameters:
note - the child nodes to add














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