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






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


All Known Implementing Classes:
NXentryImpl




public interface NXentry
extends NXsubentry
(**required**) :ref:`NXentry` describes the measurement.
 The top-level NeXus group which contains all the data and associated
 information that comprise a single measurement.
 It is mandatory that there is at least one
 group of this type in the NeXus file.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_ATTRIBUTE_DEFAULT 


static java.lang.String
NX_ATTRIBUTE_IDF_VERSION 


static java.lang.String
NX_COLLECTION_DESCRIPTION 


static java.lang.String
NX_COLLECTION_IDENTIFIER 


static java.lang.String
NX_COLLECTION_TIME 


static java.lang.String
NX_DEFINITION 


static java.lang.String
NX_DEFINITION_ATTRIBUTE_URL 


static java.lang.String
NX_DEFINITION_ATTRIBUTE_VERSION 


static java.lang.String
NX_DEFINITION_LOCAL 


static java.lang.String
NX_DEFINITION_LOCAL_ATTRIBUTE_URL 


static java.lang.String
NX_DEFINITION_LOCAL_ATTRIBUTE_VERSION 


static java.lang.String
NX_DURATION 


static java.lang.String
NX_END_TIME 


static java.lang.String
NX_ENTRY_IDENTIFIER 


static java.lang.String
NX_EXPERIMENT_DESCRIPTION 


static java.lang.String
NX_EXPERIMENT_IDENTIFIER 


static java.lang.String
NX_FEATURES 


static java.lang.String
NX_PRE_SAMPLE_FLIGHTPATH 


static java.lang.String
NX_PROGRAM_NAME 


static java.lang.String
NX_PROGRAM_NAME_ATTRIBUTE_CONFIGURATION 


static java.lang.String
NX_PROGRAM_NAME_ATTRIBUTE_VERSION 


static java.lang.String
NX_REVISION 


static java.lang.String
NX_REVISION_ATTRIBUTE_COMMENT 


static java.lang.String
NX_RUN_CYCLE 


static java.lang.String
NX_START_TIME 


static java.lang.String
NX_TITLE 






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








Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXcollection>
getAllCollection()
Get all NXcollection nodes:
 
 
 



java.util.Map<java.lang.String,NXdata>
getAllData()
Get all NXdata nodes:
 
 
 The data group
 ..



java.util.Map<java.lang.String,NXinstrument>
getAllInstrument()
Get all NXinstrument nodes:
 
 
 



java.util.Map<java.lang.String,NXmonitor>
getAllMonitor()
Get all NXmonitor nodes:
 
 
 



java.util.Map<java.lang.String,NXparameters>
getAllParameters()
Get all NXparameters nodes:
 
 
 



java.util.Map<java.lang.String,NXprocess>
getAllProcess()
Get all NXprocess nodes:
 
 
 



java.util.Map<java.lang.String,NXsample>
getAllSample()
Get all NXsample nodes:
 
 
 



java.util.Map<java.lang.String,NXsubentry>
getAllSubentry()
Get all NXsubentry nodes:
 
 
 



java.util.Map<java.lang.String,NXuser>
getAllUser()
Get all NXuser nodes:
 
 
 



java.lang.String
getAttributeDefault()
..



java.lang.String
getAttributeIDF_Version()
ISIS Muon IDF_Version



IDataset
getCollection_description()
Brief summary of the collection, including grouping criteria.



java.lang.String
getCollection_descriptionScalar()
Brief summary of the collection, including grouping criteria.



IDataset
getCollection_identifier()
User or Data Acquisition defined group of NeXus files or NXentry



java.lang.String
getCollection_identifierScalar()
User or Data Acquisition defined group of NeXus files or NXentry



IDataset
getCollection_time()
Time transpired actually collecting data i.e.



java.lang.Double
getCollection_timeScalar()
Time transpired actually collecting data i.e.



NXcollection
getCollection() 


NXcollection
getCollection(java.lang.String name)
Get a NXcollection node by name:
 
 
 



NXdata
getData()
The data group
 ..



NXdata
getData(java.lang.String name)
Get a NXdata node by name:
 
 
 The data group
 ..



IDataset
getDefinition_local()
Deprecated. 
see same field in :ref:`NXsubentry` for preferred use




java.lang.String
getDefinition_localAttributeURL()
URL of NXDL file



java.lang.String
getDefinition_localAttributeVersion()
NXDL version number



java.lang.String
getDefinition_localScalar()
Deprecated. 
see same field in :ref:`NXsubentry` for preferred use




IDataset
getDefinition()
(alternate use: see same field in :ref:`NXsubentry` for preferred)
 Official NeXus NXDL schema to which this entry conforms.



java.lang.String
getDefinitionAttributeURL()
URL of NXDL file



java.lang.String
getDefinitionAttributeVersion()
NXDL version number



java.lang.String
getDefinitionScalar()
(alternate use: see same field in :ref:`NXsubentry` for preferred)
 Official NeXus NXDL schema to which this entry conforms.



IDataset
getDuration()
Duration of measurement



java.lang.Long
getDurationScalar()
Duration of measurement



IDataset
getEnd_time()
Ending time of measurement



java.util.Date
getEnd_timeScalar()
Ending time of measurement



IDataset
getEntry_identifier()
unique identifier for the measurement, defined by the facility.



java.lang.String
getEntry_identifierScalar()
unique identifier for the measurement, defined by the facility.



IDataset
getExperiment_description()
Brief summary of the experiment, including key objectives.



java.lang.String
getExperiment_descriptionScalar()
Brief summary of the experiment, including key objectives.



NXnote
getExperiment_documentation()
Description of the full experiment (document in pdf, latex, ...)



IDataset
getExperiment_identifier()
Unique identifier for the experiment,
 defined by the facility,
 possibly linked to the proposals



java.lang.String
getExperiment_identifierScalar()
Unique identifier for the experiment,
 defined by the facility,
 possibly linked to the proposals



IDataset
getFeatures()
Reserved for future use by NIAC.



java.lang.String
getFeaturesScalar()
Reserved for future use by NIAC.



NXinstrument
getInstrument() 


NXinstrument
getInstrument(java.lang.String name)
Get a NXinstrument node by name:
 
 
 



NXmonitor
getMonitor() 


NXmonitor
getMonitor(java.lang.String name)
Get a NXmonitor node by name:
 
 
 



NXnote
getNotes()
Notes describing entry



NXparameters
getParameters() 


NXparameters
getParameters(java.lang.String name)
Get a NXparameters node by name:
 
 
 



IDataset
getPre_sample_flightpath()
This is the flightpath before the sample position.



java.lang.Double
getPre_sample_flightpathScalar()
This is the flightpath before the sample position.



NXprocess
getProcess() 


NXprocess
getProcess(java.lang.String name)
Get a NXprocess node by name:
 
 
 



IDataset
getProgram_name()
Name of program used to generate this file



java.lang.String
getProgram_nameAttributeConfiguration()
configuration of the program



java.lang.String
getProgram_nameAttributeVersion()
Program version number



java.lang.String
getProgram_nameScalar()
Name of program used to generate this file



IDataset
getRevision()
Revision id of the file due to re-calibration, reprocessing, new analysis, new
 instrument definition format, ...



java.lang.String
getRevisionAttributeComment() 


java.lang.String
getRevisionScalar()
Revision id of the file due to re-calibration, reprocessing, new analysis, new
 instrument definition format, ...



IDataset
getRun_cycle()
Such as "2007-3".



java.lang.String
getRun_cycleScalar()
Such as "2007-3".



NXsample
getSample() 


NXsample
getSample(java.lang.String name)
Get a NXsample node by name:
 
 
 



IDataset
getStart_time()
Starting time of measurement



java.util.Date
getStart_timeScalar()
Starting time of measurement



NXsubentry
getSubentry() 


NXsubentry
getSubentry(java.lang.String name)
Get a NXsubentry node by name:
 
 
 



NXnote
getThumbnail()
A small image that is representative of the entry.



IDataset
getTitle()
Extended title for entry



java.lang.String
getTitleScalar()
Extended title for entry



NXuser
getUser() 


NXuser
getUser(java.lang.String name)
Get a NXuser node by name:
 
 
 



void
setAllCollection(java.util.Map<java.lang.String,NXcollection> collection)
Set multiple child nodes of a particular type.



void
setAllData(java.util.Map<java.lang.String,NXdata> data)
Set multiple child nodes of a particular type.



void
setAllInstrument(java.util.Map<java.lang.String,NXinstrument> instrument)
Set multiple child nodes of a particular type.



void
setAllMonitor(java.util.Map<java.lang.String,NXmonitor> monitor)
Set multiple child nodes of a particular type.



void
setAllParameters(java.util.Map<java.lang.String,NXparameters> parameters)
Set multiple child nodes of a particular type.



void
setAllProcess(java.util.Map<java.lang.String,NXprocess> process)
Set multiple child nodes of a particular type.



void
setAllSample(java.util.Map<java.lang.String,NXsample> sample)
Set multiple child nodes of a particular type.



void
setAllSubentry(java.util.Map<java.lang.String,NXsubentry> subentry)
Set multiple child nodes of a particular type.



void
setAllUser(java.util.Map<java.lang.String,NXuser> user)
Set multiple child nodes of a particular type.



void
setAttributeDefault(java.lang.String default_)
..



void
setAttributeIDF_Version(java.lang.String IDF_Version)
ISIS Muon IDF_Version



DataNode
setCollection_description(IDataset collection_description)
Brief summary of the collection, including grouping criteria.



DataNode
setCollection_descriptionScalar(java.lang.String collection_description)
Brief summary of the collection, including grouping criteria.



DataNode
setCollection_identifier(IDataset collection_identifier)
User or Data Acquisition defined group of NeXus files or NXentry



DataNode
setCollection_identifierScalar(java.lang.String collection_identifier)
User or Data Acquisition defined group of NeXus files or NXentry



DataNode
setCollection_time(IDataset collection_time)
Time transpired actually collecting data i.e.



DataNode
setCollection_timeScalar(java.lang.Double collection_time)
Time transpired actually collecting data i.e.



void
setCollection(NXcollection collection) 


void
setCollection(java.lang.String name,
             NXcollection collection)
Set a NXcollection node by name:
 
 
 



void
setData(NXdata data)
The data group
 ..



void
setData(java.lang.String name,
       NXdata data)
Set a NXdata node by name:
 
 
 The data group
 ..



DataNode
setDefinition_local(IDataset definition_local)
Deprecated. 
see same field in :ref:`NXsubentry` for preferred use




void
setDefinition_localAttributeURL(java.lang.String URL)
URL of NXDL file



void
setDefinition_localAttributeVersion(java.lang.String version)
NXDL version number



DataNode
setDefinition_localScalar(java.lang.String definition_local)
Deprecated. 
see same field in :ref:`NXsubentry` for preferred use




DataNode
setDefinition(IDataset definition)
(alternate use: see same field in :ref:`NXsubentry` for preferred)
 Official NeXus NXDL schema to which this entry conforms.



void
setDefinitionAttributeURL(java.lang.String URL)
URL of NXDL file



void
setDefinitionAttributeVersion(java.lang.String version)
NXDL version number



DataNode
setDefinitionScalar(java.lang.String definition)
(alternate use: see same field in :ref:`NXsubentry` for preferred)
 Official NeXus NXDL schema to which this entry conforms.



DataNode
setDuration(IDataset duration)
Duration of measurement



DataNode
setDurationScalar(java.lang.Long duration)
Duration of measurement



DataNode
setEnd_time(IDataset end_time)
Ending time of measurement



DataNode
setEnd_timeScalar(java.util.Date end_time)
Ending time of measurement



DataNode
setEntry_identifier(IDataset entry_identifier)
unique identifier for the measurement, defined by the facility.



DataNode
setEntry_identifierScalar(java.lang.String entry_identifier)
unique identifier for the measurement, defined by the facility.



DataNode
setExperiment_description(IDataset experiment_description)
Brief summary of the experiment, including key objectives.



DataNode
setExperiment_descriptionScalar(java.lang.String experiment_description)
Brief summary of the experiment, including key objectives.



void
setExperiment_documentation(NXnote experiment_documentation)
Description of the full experiment (document in pdf, latex, ...)



DataNode
setExperiment_identifier(IDataset experiment_identifier)
Unique identifier for the experiment,
 defined by the facility,
 possibly linked to the proposals



DataNode
setExperiment_identifierScalar(java.lang.String experiment_identifier)
Unique identifier for the experiment,
 defined by the facility,
 possibly linked to the proposals



DataNode
setFeatures(IDataset features)
Reserved for future use by NIAC.



DataNode
setFeaturesScalar(java.lang.String features)
Reserved for future use by NIAC.



void
setInstrument(NXinstrument instrument) 


void
setInstrument(java.lang.String name,
             NXinstrument instrument)
Set a NXinstrument node by name:
 
 
 



void
setMonitor(NXmonitor monitor) 


void
setMonitor(java.lang.String name,
          NXmonitor monitor)
Set a NXmonitor node by name:
 
 
 



void
setNotes(NXnote notes)
Notes describing entry



void
setParameters(NXparameters parameters) 


void
setParameters(java.lang.String name,
             NXparameters parameters)
Set a NXparameters node by name:
 
 
 



DataNode
setPre_sample_flightpath(IDataset pre_sample_flightpath)
This is the flightpath before the sample position.



DataNode
setPre_sample_flightpathScalar(java.lang.Double pre_sample_flightpath)
This is the flightpath before the sample position.



void
setProcess(NXprocess process) 


void
setProcess(java.lang.String name,
          NXprocess process)
Set a NXprocess node by name:
 
 
 



DataNode
setProgram_name(IDataset program_name)
Name of program used to generate this file



void
setProgram_nameAttributeConfiguration(java.lang.String configuration)
configuration of the program



void
setProgram_nameAttributeVersion(java.lang.String version)
Program version number



DataNode
setProgram_nameScalar(java.lang.String program_name)
Name of program used to generate this file



DataNode
setRevision(IDataset revision)
Revision id of the file due to re-calibration, reprocessing, new analysis, new
 instrument definition format, ...



void
setRevisionAttributeComment(java.lang.String comment) 


DataNode
setRevisionScalar(java.lang.String revision)
Revision id of the file due to re-calibration, reprocessing, new analysis, new
 instrument definition format, ...



DataNode
setRun_cycle(IDataset run_cycle)
Such as "2007-3".



DataNode
setRun_cycleScalar(java.lang.String run_cycle)
Such as "2007-3".



void
setSample(NXsample sample) 


void
setSample(java.lang.String name,
         NXsample sample)
Set a NXsample node by name:
 
 
 



DataNode
setStart_time(IDataset start_time)
Starting time of measurement



DataNode
setStart_timeScalar(java.util.Date start_time)
Starting time of measurement



void
setSubentry(NXsubentry subentry) 


void
setSubentry(java.lang.String name,
           NXsubentry subentry)
Set a NXsubentry node by name:
 
 
 



void
setThumbnail(NXnote thumbnail)
A small image that is representative of the entry.



DataNode
setTitle(IDataset title)
Extended title for entry



DataNode
setTitleScalar(java.lang.String title)
Extended title for entry



void
setUser(NXuser user) 


void
setUser(java.lang.String name,
       NXuser user)
Set a NXuser node by name:
 
 
 







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_ATTRIBUTE_DEFAULT
static final java.lang.String NX_ATTRIBUTE_DEFAULT

See Also:
Constant Field Values








NX_ATTRIBUTE_IDF_VERSION
static final java.lang.String NX_ATTRIBUTE_IDF_VERSION

See Also:
Constant Field Values








NX_TITLE
static final java.lang.String NX_TITLE

See Also:
Constant Field Values








NX_EXPERIMENT_IDENTIFIER
static final java.lang.String NX_EXPERIMENT_IDENTIFIER

See Also:
Constant Field Values








NX_EXPERIMENT_DESCRIPTION
static final java.lang.String NX_EXPERIMENT_DESCRIPTION

See Also:
Constant Field Values








NX_COLLECTION_IDENTIFIER
static final java.lang.String NX_COLLECTION_IDENTIFIER

See Also:
Constant Field Values








NX_COLLECTION_DESCRIPTION
static final java.lang.String NX_COLLECTION_DESCRIPTION

See Also:
Constant Field Values








NX_ENTRY_IDENTIFIER
static final java.lang.String NX_ENTRY_IDENTIFIER

See Also:
Constant Field Values








NX_FEATURES
static final java.lang.String NX_FEATURES

See Also:
Constant Field Values








NX_DEFINITION
static final java.lang.String NX_DEFINITION

See Also:
Constant Field Values








NX_DEFINITION_ATTRIBUTE_VERSION
static final java.lang.String NX_DEFINITION_ATTRIBUTE_VERSION

See Also:
Constant Field Values








NX_DEFINITION_ATTRIBUTE_URL
static final java.lang.String NX_DEFINITION_ATTRIBUTE_URL

See Also:
Constant Field Values








NX_DEFINITION_LOCAL
static final java.lang.String NX_DEFINITION_LOCAL

See Also:
Constant Field Values








NX_DEFINITION_LOCAL_ATTRIBUTE_VERSION
static final java.lang.String NX_DEFINITION_LOCAL_ATTRIBUTE_VERSION

See Also:
Constant Field Values








NX_DEFINITION_LOCAL_ATTRIBUTE_URL
static final java.lang.String NX_DEFINITION_LOCAL_ATTRIBUTE_URL

See Also:
Constant Field Values








NX_START_TIME
static final java.lang.String NX_START_TIME

See Also:
Constant Field Values








NX_END_TIME
static final java.lang.String NX_END_TIME

See Also:
Constant Field Values








NX_DURATION
static final java.lang.String NX_DURATION

See Also:
Constant Field Values








NX_COLLECTION_TIME
static final java.lang.String NX_COLLECTION_TIME

See Also:
Constant Field Values








NX_RUN_CYCLE
static final java.lang.String NX_RUN_CYCLE

See Also:
Constant Field Values








NX_PROGRAM_NAME
static final java.lang.String NX_PROGRAM_NAME

See Also:
Constant Field Values








NX_PROGRAM_NAME_ATTRIBUTE_VERSION
static final java.lang.String NX_PROGRAM_NAME_ATTRIBUTE_VERSION

See Also:
Constant Field Values








NX_PROGRAM_NAME_ATTRIBUTE_CONFIGURATION
static final java.lang.String NX_PROGRAM_NAME_ATTRIBUTE_CONFIGURATION

See Also:
Constant Field Values








NX_REVISION
static final java.lang.String NX_REVISION

See Also:
Constant Field Values








NX_REVISION_ATTRIBUTE_COMMENT
static final java.lang.String NX_REVISION_ATTRIBUTE_COMMENT

See Also:
Constant Field Values








NX_PRE_SAMPLE_FLIGHTPATH
static final java.lang.String NX_PRE_SAMPLE_FLIGHTPATH

See Also:
Constant Field Values










Method Detail





getAttributeDefault
java.lang.String getAttributeDefault()
.. index:: plotting
 Declares which :ref:`NXdata` (or :ref:`NXsubentry`) group
 contains the data to be shown by default.
 It is needed to resolve ambiguity when more than one :ref:`NXdata` group exists.
 The value is the name of the default :ref:`NXdata` group.
 It is recommended (as of NIAC2014 [#]_) to use this attribute
 to help define the path to the default dataset to be plotted.
 .. [#] NIAC2014 discussion summary:
 http://wiki.nexusformat.org/2014_How_to_find_default_data

Specified by:
getAttributeDefault in interface NXsubentry
Returns:
the value.








setAttributeDefault
void setAttributeDefault(java.lang.String default_)
.. index:: plotting
 Declares which :ref:`NXdata` (or :ref:`NXsubentry`) group
 contains the data to be shown by default.
 It is needed to resolve ambiguity when more than one :ref:`NXdata` group exists.
 The value is the name of the default :ref:`NXdata` group.
 It is recommended (as of NIAC2014 [#]_) to use this attribute
 to help define the path to the default dataset to be plotted.
 .. [#] NIAC2014 discussion summary:
 http://wiki.nexusformat.org/2014_How_to_find_default_data

Specified by:
setAttributeDefault in interface NXsubentry
Parameters:
default_ - the default








getData
NXdata getData()
The data group
 .. note:: Before the NIAC2016 meeting [#]_, at least one
 :ref:`NXdata` group was required in each :ref:`NXentry` group.
 At the NIAC2016 meeting, it was decided to make :ref:`NXdata`
 an optional group in :ref:`NXentry` groups for data files that
 do not use an application definition.
 It is recommended strongly that all NeXus data files provide
 a NXdata group.
 It is permissable to omit the NXdata group only when
 defining the default plot is not practical or possible
 from the available data.
 For example, neutron event data may not have anything that
 makes a useful plot without extensive processing.
 Certain application definitions override this decision and
 require an :ref:`NXdata` group
 in the :ref:`NXentry` group. The ``minOccurs=0`` attribute
 in the application definition will indicate the
 :ref:`NXdata` group
 is optional, otherwise, it is required.
 .. [#] NIAC2016:
 http://wiki.nexusformat.org/NIAC2016,
 https://github.com/nexusformat/NIAC/issues/16

Specified by:
getData in interface NXsubentry
Returns:
the value.








setData
void setData(NXdata data)
The data group
 .. note:: Before the NIAC2016 meeting [#]_, at least one
 :ref:`NXdata` group was required in each :ref:`NXentry` group.
 At the NIAC2016 meeting, it was decided to make :ref:`NXdata`
 an optional group in :ref:`NXentry` groups for data files that
 do not use an application definition.
 It is recommended strongly that all NeXus data files provide
 a NXdata group.
 It is permissable to omit the NXdata group only when
 defining the default plot is not practical or possible
 from the available data.
 For example, neutron event data may not have anything that
 makes a useful plot without extensive processing.
 Certain application definitions override this decision and
 require an :ref:`NXdata` group
 in the :ref:`NXentry` group. The ``minOccurs=0`` attribute
 in the application definition will indicate the
 :ref:`NXdata` group
 is optional, otherwise, it is required.
 .. [#] NIAC2016:
 http://wiki.nexusformat.org/NIAC2016,
 https://github.com/nexusformat/NIAC/issues/16

Specified by:
setData in interface NXsubentry
Parameters:
data - the data








getData
NXdata getData(java.lang.String name)
Get a NXdata node by name:
 

 

 The data group
 .. note:: Before the NIAC2016 meeting [#]_, at least one
 :ref:`NXdata` group was required in each :ref:`NXentry` group.
 At the NIAC2016 meeting, it was decided to make :ref:`NXdata`
 an optional group in :ref:`NXentry` groups for data files that
 do not use an application definition.
 It is recommended strongly that all NeXus data files provide
 a NXdata group.
 It is permissable to omit the NXdata group only when
 defining the default plot is not practical or possible
 from the available data.
 For example, neutron event data may not have anything that
 makes a useful plot without extensive processing.
 Certain application definitions override this decision and
 require an :ref:`NXdata` group
 in the :ref:`NXentry` group. The ``minOccurs=0`` attribute
 in the application definition will indicate the
 :ref:`NXdata` group
 is optional, otherwise, it is required.
 .. [#] NIAC2016:
 http://wiki.nexusformat.org/NIAC2016,
 https://github.com/nexusformat/NIAC/issues/16
 

Specified by:
getData in interface NXsubentry
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXdata for that node.








setData
void setData(java.lang.String name,
             NXdata data)
Set a NXdata node by name:
 

 

 The data group
 .. note:: Before the NIAC2016 meeting [#]_, at least one
 :ref:`NXdata` group was required in each :ref:`NXentry` group.
 At the NIAC2016 meeting, it was decided to make :ref:`NXdata`
 an optional group in :ref:`NXentry` groups for data files that
 do not use an application definition.
 It is recommended strongly that all NeXus data files provide
 a NXdata group.
 It is permissable to omit the NXdata group only when
 defining the default plot is not practical or possible
 from the available data.
 For example, neutron event data may not have anything that
 makes a useful plot without extensive processing.
 Certain application definitions override this decision and
 require an :ref:`NXdata` group
 in the :ref:`NXentry` group. The ``minOccurs=0`` attribute
 in the application definition will indicate the
 :ref:`NXdata` group
 is optional, otherwise, it is required.
 .. [#] NIAC2016:
 http://wiki.nexusformat.org/NIAC2016,
 https://github.com/nexusformat/NIAC/issues/16
 

Specified by:
setData in interface NXsubentry
Parameters:
name - the name of the node
data - the value to set








getAllData
java.util.Map<java.lang.String,NXdata> getAllData()
Get all NXdata nodes:
 

 

 The data group
 .. note:: Before the NIAC2016 meeting [#]_, at least one
 :ref:`NXdata` group was required in each :ref:`NXentry` group.
 At the NIAC2016 meeting, it was decided to make :ref:`NXdata`
 an optional group in :ref:`NXentry` groups for data files that
 do not use an application definition.
 It is recommended strongly that all NeXus data files provide
 a NXdata group.
 It is permissable to omit the NXdata group only when
 defining the default plot is not practical or possible
 from the available data.
 For example, neutron event data may not have anything that
 makes a useful plot without extensive processing.
 Certain application definitions override this decision and
 require an :ref:`NXdata` group
 in the :ref:`NXentry` group. The ``minOccurs=0`` attribute
 in the application definition will indicate the
 :ref:`NXdata` group
 is optional, otherwise, it is required.
 .. [#] NIAC2016:
 http://wiki.nexusformat.org/NIAC2016,
 https://github.com/nexusformat/NIAC/issues/16
 

Specified by:
getAllData in interface NXsubentry
Returns:
a map from node names to the NXdata for that node.








setAllData
void setAllData(java.util.Map<java.lang.String,NXdata> data)
Set multiple child nodes of a particular type.
 

 

 The data group
 .. note:: Before the NIAC2016 meeting [#]_, at least one
 :ref:`NXdata` group was required in each :ref:`NXentry` group.
 At the NIAC2016 meeting, it was decided to make :ref:`NXdata`
 an optional group in :ref:`NXentry` groups for data files that
 do not use an application definition.
 It is recommended strongly that all NeXus data files provide
 a NXdata group.
 It is permissable to omit the NXdata group only when
 defining the default plot is not practical or possible
 from the available data.
 For example, neutron event data may not have anything that
 makes a useful plot without extensive processing.
 Certain application definitions override this decision and
 require an :ref:`NXdata` group
 in the :ref:`NXentry` group. The ``minOccurs=0`` attribute
 in the application definition will indicate the
 :ref:`NXdata` group
 is optional, otherwise, it is required.
 .. [#] NIAC2016:
 http://wiki.nexusformat.org/NIAC2016,
 https://github.com/nexusformat/NIAC/issues/16
 

Specified by:
setAllData in interface NXsubentry
Parameters:
data - the child nodes to add








getAttributeIDF_Version
java.lang.String getAttributeIDF_Version()
ISIS Muon IDF_Version

Specified by:
getAttributeIDF_Version in interface NXsubentry
Returns:
the value.








setAttributeIDF_Version
void setAttributeIDF_Version(java.lang.String IDF_Version)
ISIS Muon IDF_Version

Specified by:
setAttributeIDF_Version in interface NXsubentry
Parameters:
IDF_Version - the IDF_Version








getTitle
IDataset getTitle()
Extended title for entry

Specified by:
getTitle in interface NXsubentry
Returns:
the value.








setTitle
DataNode setTitle(IDataset title)
Extended title for entry

Specified by:
setTitle in interface NXsubentry
Parameters:
title - the title








getTitleScalar
java.lang.String getTitleScalar()
Extended title for entry

Specified by:
getTitleScalar in interface NXsubentry
Returns:
the value.








setTitleScalar
DataNode setTitleScalar(java.lang.String title)
Extended title for entry

Specified by:
setTitleScalar in interface NXsubentry
Parameters:
title - the title








getExperiment_identifier
IDataset getExperiment_identifier()
Unique identifier for the experiment,
 defined by the facility,
 possibly linked to the proposals

Specified by:
getExperiment_identifier in interface NXsubentry
Returns:
the value.








setExperiment_identifier
DataNode setExperiment_identifier(IDataset experiment_identifier)
Unique identifier for the experiment,
 defined by the facility,
 possibly linked to the proposals

Specified by:
setExperiment_identifier in interface NXsubentry
Parameters:
experiment_identifier - the experiment_identifier








getExperiment_identifierScalar
java.lang.String getExperiment_identifierScalar()
Unique identifier for the experiment,
 defined by the facility,
 possibly linked to the proposals

Specified by:
getExperiment_identifierScalar in interface NXsubentry
Returns:
the value.








setExperiment_identifierScalar
DataNode setExperiment_identifierScalar(java.lang.String experiment_identifier)
Unique identifier for the experiment,
 defined by the facility,
 possibly linked to the proposals

Specified by:
setExperiment_identifierScalar in interface NXsubentry
Parameters:
experiment_identifier - the experiment_identifier








getExperiment_description
IDataset getExperiment_description()
Brief summary of the experiment, including key objectives.

Specified by:
getExperiment_description in interface NXsubentry
Returns:
the value.








setExperiment_description
DataNode setExperiment_description(IDataset experiment_description)
Brief summary of the experiment, including key objectives.

Specified by:
setExperiment_description in interface NXsubentry
Parameters:
experiment_description - the experiment_description








getExperiment_descriptionScalar
java.lang.String getExperiment_descriptionScalar()
Brief summary of the experiment, including key objectives.

Specified by:
getExperiment_descriptionScalar in interface NXsubentry
Returns:
the value.








setExperiment_descriptionScalar
DataNode setExperiment_descriptionScalar(java.lang.String experiment_description)
Brief summary of the experiment, including key objectives.

Specified by:
setExperiment_descriptionScalar in interface NXsubentry
Parameters:
experiment_description - the experiment_description








getExperiment_documentation
NXnote getExperiment_documentation()
Description of the full experiment (document in pdf, latex, ...)

Specified by:
getExperiment_documentation in interface NXsubentry
Returns:
the value.








setExperiment_documentation
void setExperiment_documentation(NXnote experiment_documentation)
Description of the full experiment (document in pdf, latex, ...)

Specified by:
setExperiment_documentation in interface NXsubentry
Parameters:
experiment_documentation - the experiment_documentation








getCollection_identifier
IDataset getCollection_identifier()
User or Data Acquisition defined group of NeXus files or NXentry

Specified by:
getCollection_identifier in interface NXsubentry
Returns:
the value.








setCollection_identifier
DataNode setCollection_identifier(IDataset collection_identifier)
User or Data Acquisition defined group of NeXus files or NXentry

Specified by:
setCollection_identifier in interface NXsubentry
Parameters:
collection_identifier - the collection_identifier








getCollection_identifierScalar
java.lang.String getCollection_identifierScalar()
User or Data Acquisition defined group of NeXus files or NXentry

Specified by:
getCollection_identifierScalar in interface NXsubentry
Returns:
the value.








setCollection_identifierScalar
DataNode setCollection_identifierScalar(java.lang.String collection_identifier)
User or Data Acquisition defined group of NeXus files or NXentry

Specified by:
setCollection_identifierScalar in interface NXsubentry
Parameters:
collection_identifier - the collection_identifier








getCollection_description
IDataset getCollection_description()
Brief summary of the collection, including grouping criteria.

Specified by:
getCollection_description in interface NXsubentry
Returns:
the value.








setCollection_description
DataNode setCollection_description(IDataset collection_description)
Brief summary of the collection, including grouping criteria.

Specified by:
setCollection_description in interface NXsubentry
Parameters:
collection_description - the collection_description








getCollection_descriptionScalar
java.lang.String getCollection_descriptionScalar()
Brief summary of the collection, including grouping criteria.

Specified by:
getCollection_descriptionScalar in interface NXsubentry
Returns:
the value.








setCollection_descriptionScalar
DataNode setCollection_descriptionScalar(java.lang.String collection_description)
Brief summary of the collection, including grouping criteria.

Specified by:
setCollection_descriptionScalar in interface NXsubentry
Parameters:
collection_description - the collection_description








getEntry_identifier
IDataset getEntry_identifier()
unique identifier for the measurement, defined by the facility.

Specified by:
getEntry_identifier in interface NXsubentry
Returns:
the value.








setEntry_identifier
DataNode setEntry_identifier(IDataset entry_identifier)
unique identifier for the measurement, defined by the facility.

Specified by:
setEntry_identifier in interface NXsubentry
Parameters:
entry_identifier - the entry_identifier








getEntry_identifierScalar
java.lang.String getEntry_identifierScalar()
unique identifier for the measurement, defined by the facility.

Specified by:
getEntry_identifierScalar in interface NXsubentry
Returns:
the value.








setEntry_identifierScalar
DataNode setEntry_identifierScalar(java.lang.String entry_identifier)
unique identifier for the measurement, defined by the facility.

Specified by:
setEntry_identifierScalar in interface NXsubentry
Parameters:
entry_identifier - the entry_identifier








getFeatures
IDataset getFeatures()
Reserved for future use by NIAC.
 See https://github.com/nexusformat/definitions/issues/382

Returns:
the value.








setFeatures
DataNode setFeatures(IDataset features)
Reserved for future use by NIAC.
 See https://github.com/nexusformat/definitions/issues/382

Parameters:
features - the features








getFeaturesScalar
java.lang.String getFeaturesScalar()
Reserved for future use by NIAC.
 See https://github.com/nexusformat/definitions/issues/382

Returns:
the value.








setFeaturesScalar
DataNode setFeaturesScalar(java.lang.String features)
Reserved for future use by NIAC.
 See https://github.com/nexusformat/definitions/issues/382

Parameters:
features - the features








getDefinition
IDataset getDefinition()
(alternate use: see same field in :ref:`NXsubentry` for preferred)
 Official NeXus NXDL schema to which this entry conforms.
 This field is provided so that :ref:`NXentry` can be the overlay position
 in a NeXus data file for an application definition and its
 set of groups, fields, and attributes.
 *It is advised* to use :ref:`NXsubentry`, instead, as the overlay position.

Specified by:
getDefinition in interface NXsubentry
Returns:
the value.








setDefinition
DataNode setDefinition(IDataset definition)
(alternate use: see same field in :ref:`NXsubentry` for preferred)
 Official NeXus NXDL schema to which this entry conforms.
 This field is provided so that :ref:`NXentry` can be the overlay position
 in a NeXus data file for an application definition and its
 set of groups, fields, and attributes.
 *It is advised* to use :ref:`NXsubentry`, instead, as the overlay position.

Specified by:
setDefinition in interface NXsubentry
Parameters:
definition - the definition








getDefinitionScalar
java.lang.String getDefinitionScalar()
(alternate use: see same field in :ref:`NXsubentry` for preferred)
 Official NeXus NXDL schema to which this entry conforms.
 This field is provided so that :ref:`NXentry` can be the overlay position
 in a NeXus data file for an application definition and its
 set of groups, fields, and attributes.
 *It is advised* to use :ref:`NXsubentry`, instead, as the overlay position.

Specified by:
getDefinitionScalar in interface NXsubentry
Returns:
the value.








setDefinitionScalar
DataNode setDefinitionScalar(java.lang.String definition)
(alternate use: see same field in :ref:`NXsubentry` for preferred)
 Official NeXus NXDL schema to which this entry conforms.
 This field is provided so that :ref:`NXentry` can be the overlay position
 in a NeXus data file for an application definition and its
 set of groups, fields, and attributes.
 *It is advised* to use :ref:`NXsubentry`, instead, as the overlay position.

Specified by:
setDefinitionScalar in interface NXsubentry
Parameters:
definition - the definition








getDefinitionAttributeVersion
java.lang.String getDefinitionAttributeVersion()
NXDL version number

Specified by:
getDefinitionAttributeVersion in interface NXsubentry
Returns:
the value.








setDefinitionAttributeVersion
void setDefinitionAttributeVersion(java.lang.String version)
NXDL version number

Specified by:
setDefinitionAttributeVersion in interface NXsubentry
Parameters:
version - the version








getDefinitionAttributeURL
java.lang.String getDefinitionAttributeURL()
URL of NXDL file

Specified by:
getDefinitionAttributeURL in interface NXsubentry
Returns:
the value.








setDefinitionAttributeURL
void setDefinitionAttributeURL(java.lang.String URL)
URL of NXDL file

Specified by:
setDefinitionAttributeURL in interface NXsubentry
Parameters:
URL - the URL








getDefinition_local
@Deprecated
IDataset getDefinition_local()
Deprecated. see same field in :ref:`NXsubentry` for preferred use
Local NXDL schema extended from the entry
 specified in the ``definition`` field.
 This contains any locally-defined,
 additional fields in the entry.

Specified by:
getDefinition_local in interface NXsubentry
Returns:
the value.








setDefinition_local
@Deprecated
DataNode setDefinition_local(IDataset definition_local)
Deprecated. see same field in :ref:`NXsubentry` for preferred use
Local NXDL schema extended from the entry
 specified in the ``definition`` field.
 This contains any locally-defined,
 additional fields in the entry.

Specified by:
setDefinition_local in interface NXsubentry
Parameters:
definition_local - the definition_local








getDefinition_localScalar
@Deprecated
java.lang.String getDefinition_localScalar()
Deprecated. see same field in :ref:`NXsubentry` for preferred use
Local NXDL schema extended from the entry
 specified in the ``definition`` field.
 This contains any locally-defined,
 additional fields in the entry.

Specified by:
getDefinition_localScalar in interface NXsubentry
Returns:
the value.








setDefinition_localScalar
@Deprecated
DataNode setDefinition_localScalar(java.lang.String definition_local)
Deprecated. see same field in :ref:`NXsubentry` for preferred use
Local NXDL schema extended from the entry
 specified in the ``definition`` field.
 This contains any locally-defined,
 additional fields in the entry.

Specified by:
setDefinition_localScalar in interface NXsubentry
Parameters:
definition_local - the definition_local








getDefinition_localAttributeVersion
java.lang.String getDefinition_localAttributeVersion()
NXDL version number

Specified by:
getDefinition_localAttributeVersion in interface NXsubentry
Returns:
the value.








setDefinition_localAttributeVersion
void setDefinition_localAttributeVersion(java.lang.String version)
NXDL version number

Specified by:
setDefinition_localAttributeVersion in interface NXsubentry
Parameters:
version - the version








getDefinition_localAttributeURL
java.lang.String getDefinition_localAttributeURL()
URL of NXDL file

Specified by:
getDefinition_localAttributeURL in interface NXsubentry
Returns:
the value.








setDefinition_localAttributeURL
void setDefinition_localAttributeURL(java.lang.String URL)
URL of NXDL file

Specified by:
setDefinition_localAttributeURL in interface NXsubentry
Parameters:
URL - the URL








getStart_time
IDataset getStart_time()
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
getStart_time in interface NXsubentry
Returns:
the value.








setStart_time
DataNode setStart_time(IDataset start_time)
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
setStart_time in interface NXsubentry
Parameters:
start_time - the start_time








getStart_timeScalar
java.util.Date getStart_timeScalar()
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
getStart_timeScalar in interface NXsubentry
Returns:
the value.








setStart_timeScalar
DataNode setStart_timeScalar(java.util.Date start_time)
Starting time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
setStart_timeScalar in interface NXsubentry
Parameters:
start_time - the start_time








getEnd_time
IDataset getEnd_time()
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
getEnd_time in interface NXsubentry
Returns:
the value.








setEnd_time
DataNode setEnd_time(IDataset end_time)
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
setEnd_time in interface NXsubentry
Parameters:
end_time - the end_time








getEnd_timeScalar
java.util.Date getEnd_timeScalar()
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
getEnd_timeScalar in interface NXsubentry
Returns:
the value.








setEnd_timeScalar
DataNode setEnd_timeScalar(java.util.Date end_time)
Ending time of measurement
 

 Type: NX_DATE_TIME
 

Specified by:
setEnd_timeScalar in interface NXsubentry
Parameters:
end_time - the end_time








getDuration
IDataset getDuration()
Duration of measurement
 

 Type: NX_INT
 Units: NX_TIME
 

Specified by:
getDuration in interface NXsubentry
Returns:
the value.








setDuration
DataNode setDuration(IDataset duration)
Duration of measurement
 

 Type: NX_INT
 Units: NX_TIME
 

Specified by:
setDuration in interface NXsubentry
Parameters:
duration - the duration








getDurationScalar
java.lang.Long getDurationScalar()
Duration of measurement
 

 Type: NX_INT
 Units: NX_TIME
 

Specified by:
getDurationScalar in interface NXsubentry
Returns:
the value.








setDurationScalar
DataNode setDurationScalar(java.lang.Long duration)
Duration of measurement
 

 Type: NX_INT
 Units: NX_TIME
 

Specified by:
setDurationScalar in interface NXsubentry
Parameters:
duration - the duration








getCollection_time
IDataset getCollection_time()
Time transpired actually collecting data i.e. taking out time when collection was
 suspended due to e.g. temperature out of range
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
getCollection_time in interface NXsubentry
Returns:
the value.








setCollection_time
DataNode setCollection_time(IDataset collection_time)
Time transpired actually collecting data i.e. taking out time when collection was
 suspended due to e.g. temperature out of range
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
setCollection_time in interface NXsubentry
Parameters:
collection_time - the collection_time








getCollection_timeScalar
java.lang.Double getCollection_timeScalar()
Time transpired actually collecting data i.e. taking out time when collection was
 suspended due to e.g. temperature out of range
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
getCollection_timeScalar in interface NXsubentry
Returns:
the value.








setCollection_timeScalar
DataNode setCollection_timeScalar(java.lang.Double collection_time)
Time transpired actually collecting data i.e. taking out time when collection was
 suspended due to e.g. temperature out of range
 

 Type: NX_FLOAT
 Units: NX_TIME
 

Specified by:
setCollection_timeScalar in interface NXsubentry
Parameters:
collection_time - the collection_time








getRun_cycle
IDataset getRun_cycle()
Such as "2007-3". Some user facilities organize their beam time into run cycles.

Specified by:
getRun_cycle in interface NXsubentry
Returns:
the value.








setRun_cycle
DataNode setRun_cycle(IDataset run_cycle)
Such as "2007-3". Some user facilities organize their beam time into run cycles.

Specified by:
setRun_cycle in interface NXsubentry
Parameters:
run_cycle - the run_cycle








getRun_cycleScalar
java.lang.String getRun_cycleScalar()
Such as "2007-3". Some user facilities organize their beam time into run cycles.

Specified by:
getRun_cycleScalar in interface NXsubentry
Returns:
the value.








setRun_cycleScalar
DataNode setRun_cycleScalar(java.lang.String run_cycle)
Such as "2007-3". Some user facilities organize their beam time into run cycles.

Specified by:
setRun_cycleScalar in interface NXsubentry
Parameters:
run_cycle - the run_cycle








getProgram_name
IDataset getProgram_name()
Name of program used to generate this file

Specified by:
getProgram_name in interface NXsubentry
Returns:
the value.








setProgram_name
DataNode setProgram_name(IDataset program_name)
Name of program used to generate this file

Specified by:
setProgram_name in interface NXsubentry
Parameters:
program_name - the program_name








getProgram_nameScalar
java.lang.String getProgram_nameScalar()
Name of program used to generate this file

Specified by:
getProgram_nameScalar in interface NXsubentry
Returns:
the value.








setProgram_nameScalar
DataNode setProgram_nameScalar(java.lang.String program_name)
Name of program used to generate this file

Specified by:
setProgram_nameScalar in interface NXsubentry
Parameters:
program_name - the program_name








getProgram_nameAttributeVersion
java.lang.String getProgram_nameAttributeVersion()
Program version number

Specified by:
getProgram_nameAttributeVersion in interface NXsubentry
Returns:
the value.








setProgram_nameAttributeVersion
void setProgram_nameAttributeVersion(java.lang.String version)
Program version number

Specified by:
setProgram_nameAttributeVersion in interface NXsubentry
Parameters:
version - the version








getProgram_nameAttributeConfiguration
java.lang.String getProgram_nameAttributeConfiguration()
configuration of the program

Specified by:
getProgram_nameAttributeConfiguration in interface NXsubentry
Returns:
the value.








setProgram_nameAttributeConfiguration
void setProgram_nameAttributeConfiguration(java.lang.String configuration)
configuration of the program

Specified by:
setProgram_nameAttributeConfiguration in interface NXsubentry
Parameters:
configuration - the configuration








getRevision
IDataset getRevision()
Revision id of the file due to re-calibration, reprocessing, new analysis, new
 instrument definition format, ...

Specified by:
getRevision in interface NXsubentry
Returns:
the value.








setRevision
DataNode setRevision(IDataset revision)
Revision id of the file due to re-calibration, reprocessing, new analysis, new
 instrument definition format, ...

Specified by:
setRevision in interface NXsubentry
Parameters:
revision - the revision








getRevisionScalar
java.lang.String getRevisionScalar()
Revision id of the file due to re-calibration, reprocessing, new analysis, new
 instrument definition format, ...

Specified by:
getRevisionScalar in interface NXsubentry
Returns:
the value.








setRevisionScalar
DataNode setRevisionScalar(java.lang.String revision)
Revision id of the file due to re-calibration, reprocessing, new analysis, new
 instrument definition format, ...

Specified by:
setRevisionScalar in interface NXsubentry
Parameters:
revision - the revision








getRevisionAttributeComment
java.lang.String getRevisionAttributeComment()

Specified by:
getRevisionAttributeComment in interface NXsubentry
Returns:
the value.








setRevisionAttributeComment
void setRevisionAttributeComment(java.lang.String comment)

Specified by:
setRevisionAttributeComment in interface NXsubentry
Parameters:
comment - the comment








getPre_sample_flightpath
IDataset getPre_sample_flightpath()
This is the flightpath before the sample position. This can be determined by a chopper,
 by the moderator or the source itself. In other words: it the distance to the component
 which gives the T0 signal to the detector electronics. If another component in the
 NXinstrument hierarchy provides this information, this should be a link.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getPre_sample_flightpath in interface NXsubentry
Returns:
the value.








setPre_sample_flightpath
DataNode setPre_sample_flightpath(IDataset pre_sample_flightpath)
This is the flightpath before the sample position. This can be determined by a chopper,
 by the moderator or the source itself. In other words: it the distance to the component
 which gives the T0 signal to the detector electronics. If another component in the
 NXinstrument hierarchy provides this information, this should be a link.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setPre_sample_flightpath in interface NXsubentry
Parameters:
pre_sample_flightpath - the pre_sample_flightpath








getPre_sample_flightpathScalar
java.lang.Double getPre_sample_flightpathScalar()
This is the flightpath before the sample position. This can be determined by a chopper,
 by the moderator or the source itself. In other words: it the distance to the component
 which gives the T0 signal to the detector electronics. If another component in the
 NXinstrument hierarchy provides this information, this should be a link.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
getPre_sample_flightpathScalar in interface NXsubentry
Returns:
the value.








setPre_sample_flightpathScalar
DataNode setPre_sample_flightpathScalar(java.lang.Double pre_sample_flightpath)
This is the flightpath before the sample position. This can be determined by a chopper,
 by the moderator or the source itself. In other words: it the distance to the component
 which gives the T0 signal to the detector electronics. If another component in the
 NXinstrument hierarchy provides this information, this should be a link.
 

 Type: NX_FLOAT
 Units: NX_LENGTH
 

Specified by:
setPre_sample_flightpathScalar in interface NXsubentry
Parameters:
pre_sample_flightpath - the pre_sample_flightpath








getNotes
NXnote getNotes()
Notes describing entry

Specified by:
getNotes in interface NXsubentry
Returns:
the value.








setNotes
void setNotes(NXnote notes)
Notes describing entry

Specified by:
setNotes in interface NXsubentry
Parameters:
notes - the notes








getThumbnail
NXnote getThumbnail()
A small image that is representative of the entry. An example of this is a 640x480
 jpeg image automatically produced by a low resolution plot of the NXdata.

Specified by:
getThumbnail in interface NXsubentry
Returns:
the value.








setThumbnail
void setThumbnail(NXnote thumbnail)
A small image that is representative of the entry. An example of this is a 640x480
 jpeg image automatically produced by a low resolution plot of the NXdata.

Specified by:
setThumbnail in interface NXsubentry
Parameters:
thumbnail - the thumbnail








getUser
NXuser getUser()

Specified by:
getUser in interface NXsubentry
Returns:
the value.








setUser
void setUser(NXuser user)

Specified by:
setUser in interface NXsubentry
Parameters:
user - the user








getUser
NXuser getUser(java.lang.String name)
Get a NXuser node by name:
 

 

 

Specified by:
getUser in interface NXsubentry
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXuser for that node.








setUser
void setUser(java.lang.String name,
             NXuser user)
Set a NXuser node by name:
 

 

 

Specified by:
setUser in interface NXsubentry
Parameters:
name - the name of the node
user - the value to set








getAllUser
java.util.Map<java.lang.String,NXuser> getAllUser()
Get all NXuser nodes:
 

 

 

Specified by:
getAllUser in interface NXsubentry
Returns:
a map from node names to the NXuser for that node.








setAllUser
void setAllUser(java.util.Map<java.lang.String,NXuser> user)
Set multiple child nodes of a particular type.
 

 

 

Specified by:
setAllUser in interface NXsubentry
Parameters:
user - the child nodes to add








getSample
NXsample getSample()

Specified by:
getSample in interface NXsubentry
Returns:
the value.








setSample
void setSample(NXsample sample)

Specified by:
setSample in interface NXsubentry
Parameters:
sample - the sample








getSample
NXsample getSample(java.lang.String name)
Get a NXsample node by name:
 

 

 

Specified by:
getSample in interface NXsubentry
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXsample for that node.








setSample
void setSample(java.lang.String name,
               NXsample sample)
Set a NXsample node by name:
 

 

 

Specified by:
setSample in interface NXsubentry
Parameters:
name - the name of the node
sample - the value to set








getAllSample
java.util.Map<java.lang.String,NXsample> getAllSample()
Get all NXsample nodes:
 

 

 

Specified by:
getAllSample in interface NXsubentry
Returns:
a map from node names to the NXsample for that node.








setAllSample
void setAllSample(java.util.Map<java.lang.String,NXsample> sample)
Set multiple child nodes of a particular type.
 

 

 

Specified by:
setAllSample in interface NXsubentry
Parameters:
sample - the child nodes to add








getInstrument
NXinstrument getInstrument()

Specified by:
getInstrument in interface NXsubentry
Returns:
the value.








setInstrument
void setInstrument(NXinstrument instrument)

Specified by:
setInstrument in interface NXsubentry
Parameters:
instrument - the instrument








getInstrument
NXinstrument getInstrument(java.lang.String name)
Get a NXinstrument node by name:
 

 

 

Specified by:
getInstrument in interface NXsubentry
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXinstrument for that node.








setInstrument
void setInstrument(java.lang.String name,
                   NXinstrument instrument)
Set a NXinstrument node by name:
 

 

 

Specified by:
setInstrument in interface NXsubentry
Parameters:
name - the name of the node
instrument - the value to set








getAllInstrument
java.util.Map<java.lang.String,NXinstrument> getAllInstrument()
Get all NXinstrument nodes:
 

 

 

Specified by:
getAllInstrument in interface NXsubentry
Returns:
a map from node names to the NXinstrument for that node.








setAllInstrument
void setAllInstrument(java.util.Map<java.lang.String,NXinstrument> instrument)
Set multiple child nodes of a particular type.
 

 

 

Specified by:
setAllInstrument in interface NXsubentry
Parameters:
instrument - the child nodes to add








getCollection
NXcollection getCollection()

Specified by:
getCollection in interface NXsubentry
Returns:
the value.








setCollection
void setCollection(NXcollection collection)

Specified by:
setCollection in interface NXsubentry
Parameters:
collection - the collection








getCollection
NXcollection getCollection(java.lang.String name)
Get a NXcollection node by name:
 

 

 

Specified by:
getCollection in interface NXsubentry
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXcollection for that node.








setCollection
void setCollection(java.lang.String name,
                   NXcollection collection)
Set a NXcollection node by name:
 

 

 

Specified by:
setCollection in interface NXsubentry
Parameters:
name - the name of the node
collection - the value to set








getAllCollection
java.util.Map<java.lang.String,NXcollection> getAllCollection()
Get all NXcollection nodes:
 

 

 

Specified by:
getAllCollection in interface NXsubentry
Returns:
a map from node names to the NXcollection for that node.








setAllCollection
void setAllCollection(java.util.Map<java.lang.String,NXcollection> collection)
Set multiple child nodes of a particular type.
 

 

 

Specified by:
setAllCollection in interface NXsubentry
Parameters:
collection - the child nodes to add








getMonitor
NXmonitor getMonitor()

Specified by:
getMonitor in interface NXsubentry
Returns:
the value.








setMonitor
void setMonitor(NXmonitor monitor)

Specified by:
setMonitor in interface NXsubentry
Parameters:
monitor - the monitor








getMonitor
NXmonitor getMonitor(java.lang.String name)
Get a NXmonitor node by name:
 

 

 

Specified by:
getMonitor in interface NXsubentry
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXmonitor for that node.








setMonitor
void setMonitor(java.lang.String name,
                NXmonitor monitor)
Set a NXmonitor node by name:
 

 

 

Specified by:
setMonitor in interface NXsubentry
Parameters:
name - the name of the node
monitor - the value to set








getAllMonitor
java.util.Map<java.lang.String,NXmonitor> getAllMonitor()
Get all NXmonitor nodes:
 

 

 

Specified by:
getAllMonitor in interface NXsubentry
Returns:
a map from node names to the NXmonitor for that node.








setAllMonitor
void setAllMonitor(java.util.Map<java.lang.String,NXmonitor> monitor)
Set multiple child nodes of a particular type.
 

 

 

Specified by:
setAllMonitor in interface NXsubentry
Parameters:
monitor - the child nodes to add








getParameters
NXparameters getParameters()

Specified by:
getParameters in interface NXsubentry
Returns:
the value.








setParameters
void setParameters(NXparameters parameters)

Specified by:
setParameters in interface NXsubentry
Parameters:
parameters - the parameters








getParameters
NXparameters getParameters(java.lang.String name)
Get a NXparameters node by name:
 

 

 

Specified by:
getParameters in interface NXsubentry
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXparameters for that node.








setParameters
void setParameters(java.lang.String name,
                   NXparameters parameters)
Set a NXparameters node by name:
 

 

 

Specified by:
setParameters in interface NXsubentry
Parameters:
name - the name of the node
parameters - the value to set








getAllParameters
java.util.Map<java.lang.String,NXparameters> getAllParameters()
Get all NXparameters nodes:
 

 

 

Specified by:
getAllParameters in interface NXsubentry
Returns:
a map from node names to the NXparameters for that node.








setAllParameters
void setAllParameters(java.util.Map<java.lang.String,NXparameters> parameters)
Set multiple child nodes of a particular type.
 

 

 

Specified by:
setAllParameters in interface NXsubentry
Parameters:
parameters - the child nodes to add








getProcess
NXprocess getProcess()

Specified by:
getProcess in interface NXsubentry
Returns:
the value.








setProcess
void setProcess(NXprocess process)

Specified by:
setProcess in interface NXsubentry
Parameters:
process - the process








getProcess
NXprocess getProcess(java.lang.String name)
Get a NXprocess node by name:
 

 

 

Specified by:
getProcess in interface NXsubentry
Parameters:
name - the name of the node.
Returns:
a map from node names to the NXprocess for that node.








setProcess
void setProcess(java.lang.String name,
                NXprocess process)
Set a NXprocess node by name:
 

 

 

Specified by:
setProcess in interface NXsubentry
Parameters:
name - the name of the node
process - the value to set








getAllProcess
java.util.Map<java.lang.String,NXprocess> getAllProcess()
Get all NXprocess nodes:
 

 

 

Specified by:
getAllProcess in interface NXsubentry
Returns:
a map from node names to the NXprocess for that node.








setAllProcess
void setAllProcess(java.util.Map<java.lang.String,NXprocess> process)
Set multiple child nodes of a particular type.
 

 

 

Specified by:
setAllProcess in interface NXsubentry
Parameters:
process - the child nodes to add








getSubentry
NXsubentry getSubentry()

Returns:
the value.








setSubentry
void setSubentry(NXsubentry subentry)

Parameters:
subentry - the subentry








getSubentry
NXsubentry getSubentry(java.lang.String name)
Get a NXsubentry node by name:
 

 

 

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








setSubentry
void setSubentry(java.lang.String name,
                 NXsubentry subentry)
Set a NXsubentry node by name:
 

 

 

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








getAllSubentry
java.util.Map<java.lang.String,NXsubentry> getAllSubentry()
Get all NXsubentry nodes:
 

 

 

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








setAllSubentry
void setAllSubentry(java.util.Map<java.lang.String,NXsubentry> subentry)
Set multiple child nodes of a particular type.
 

 

 

Parameters:
subentry - 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