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



java.lang.Object


org.eclipse.dawnsci.analysis.tree.impl.NodeImpl


org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl


org.eclipse.dawnsci.nexus.impl.NXobjectImpl


org.eclipse.dawnsci.nexus.impl.NXsubentryImpl













All Implemented Interfaces:
java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXobject, NXsubentry




public class NXsubentryImpl
extends NXobjectImpl
implements NXsubentry
Group of multiple application definitions for "multi-modal" (e.g. SAXS/WAXS) measurements.
 ``NXsubentry`` is a base class virtually identical to :ref:`NXentry`
 and is used as the (overlay) location for application definitions.
 Use a separate ``NXsubentry`` for each application definition.
 To use ``NXsubentry`` with a hypothetical application definition
 called ``NXmyappdef``:
 * Create a group with attribute ``NX_class="NXsubentry"``
 * Within that group, create a field called ``definition="NXmyappdef"``.
 * There are two optional attributes of definition: ``version`` and ``URL``
 The intended use is to define application definitions for a
 multi-modal (a.k.a. multi-technique) :ref:`NXentry`.
 Previously, an application definition
 replaced :ref:`NXentry` with its own definition.
 With the increasing popularity of instruments combining
 multiple techniques for data collection (such as SAXS/WAXS instruments),
 it was recognized the application definitions must be entered in the NeXus
 data file tree as children of :ref:`NXentry`.

See Also:
Serialized Form












Field Summary

Fields 

Modifier and Type
Field and Description


static java.util.Set<NexusBaseClass>
PERMITTED_CHILD_GROUP_CLASSES 






Fields inherited from class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
NX_CLASS





Fields inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
attributes, id, INDENT





Fields inherited from interface org.eclipse.dawnsci.nexus.NXsubentry
NX_ATTRIBUTE_DEFAULT, NX_ATTRIBUTE_IDF_VERSION, NX_COLLECTION_DESCRIPTION, NX_COLLECTION_IDENTIFIER, NX_COLLECTION_TIME, NX_DEFINITION, NX_DEFINITION_ATTRIBUTE_URL, NX_DEFINITION_ATTRIBUTE_VERSION, NX_DEFINITION_LOCAL, NX_DEFINITION_LOCAL_ATTRIBUTE_URL, NX_DEFINITION_LOCAL_ATTRIBUTE_VERSION, NX_DURATION, NX_END_TIME, NX_ENTRY_IDENTIFIER, NX_EXPERIMENT_DESCRIPTION, NX_EXPERIMENT_IDENTIFIER, NX_PRE_SAMPLE_FLIGHTPATH, NX_PROGRAM_NAME, NX_PROGRAM_NAME_ATTRIBUTE_CONFIGURATION, NX_PROGRAM_NAME_ATTRIBUTE_VERSION, NX_REVISION, NX_REVISION_ATTRIBUTE_COMMENT, NX_RUN_CYCLE, NX_START_TIME, NX_TITLE





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








Constructor Summary

Constructors 

Constructor and Description


NXsubentryImpl() 


NXsubentryImpl(long oid) 









Method Summary

All Methods Instance Methods Concrete 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:
 
 
 



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,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 :ref:`NXentry`



java.lang.String
getCollection_identifierScalar()
User or Data Acquisition defined group of NeXus files or :ref:`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() 


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



IDataset
getDefinition_local()
Local NXDL schema extended from the subentry
 specified in the ``definition`` field.



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



java.lang.String
getDefinition_localAttributeVersion()
NXDL version number



java.lang.String
getDefinition_localScalar()
Local NXDL schema extended from the subentry
 specified in the ``definition`` field.



IDataset
getDefinition()
Official NeXus NXDL schema to which this subentry conforms



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



java.lang.String
getDefinitionAttributeVersion()
NXDL version number



java.lang.String
getDefinitionScalar()
Official NeXus NXDL schema to which this subentry 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



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:
 
 
 



NexusBaseClass
getNexusBaseClass()
Enum constant from NexusBaseClass for this base class, e.g.



NXnote
getNotes()
Notes describing entry



java.lang.Class<? extends NXobject>
getNXclass()
Java Class object of the interface for this base class, e.g.



NXparameters
getParameters() 


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



java.util.Set<NexusBaseClass>
getPermittedChildGroupClasses()
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.



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



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
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 :ref:`NXentry`



DataNode
setCollection_identifierScalar(java.lang.String collection_identifier)
User or Data Acquisition defined group of NeXus files or :ref:`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) 


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



DataNode
setDefinition_local(IDataset definition_local)
Local NXDL schema extended from the subentry
 specified in the ``definition`` field.



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)
Local NXDL schema extended from the subentry
 specified in the ``definition`` field.



DataNode
setDefinition(IDataset definition)
Official NeXus NXDL schema to which this subentry 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)
Official NeXus NXDL schema to which this subentry 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



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
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 class org.eclipse.dawnsci.nexus.impl.NXobjectImpl
addExternalLink, appendNodeString, canAddChild, createDataNode, getAllDatasets, getAttr, getAttrBoolean, getAttrDate, getAttrDouble, getAttrLong, getAttrNumber, getAttrString, getBoolean, getChild, getChildren, getChildren, getDataset, getDate, getDouble, getLazyWritableDataset, getLong, getNumber, getString, initializeFixedSizeLazyDataset, initializeLazyDataset, initializeLazyDataset, putChild, setAttribute, setChildren, setDataset, setDate, setField, setString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.GroupNodeImpl
addDataNode, addGroupNode, addNode, addNodeLink, addSymbolicNode, containsDataNode, containsGroupNode, containsNode, containsSymbolicNode, createNodeLink, findLinkedNodeName, findNodeLink, getDataNode, getDataNodeMap, getDataNodes, getDatasets, getGlobalPool, getGroupNode, getGroupNodeMap, getGroupNodes, getNames, getNode, getNodeLink, getNodeNameIterator, getNumberOfDataNodes, getNumberOfGroupNodes, getNumberOfNodelinks, getSymbolicNode, isGroupNode, isPopulated, iterator, removeDataNode, removeDataNode, removeGroupNode, removeGroupNode, removeSymbolicNode, removeSymbolicNode, setGlobalPool, toString





Methods inherited from class org.eclipse.dawnsci.analysis.tree.impl.NodeImpl
addAttribute, containsAttribute, getAttribute, getAttributeIterator, getAttributeNameIterator, getID, getNumberOfAttributes, isDataNode, isSymbolicNode





Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait





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, getNumber, 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





PERMITTED_CHILD_GROUP_CLASSES
public static final java.util.Set<NexusBaseClass> PERMITTED_CHILD_GROUP_CLASSES









Constructor Detail





NXsubentryImpl
public NXsubentryImpl()







NXsubentryImpl
public NXsubentryImpl(long oid)









Method Detail





getNXclass
public java.lang.Class<? extends NXobject> getNXclass()
Description copied from interface: NXobject
Java Class object of the interface for this base class, e.g. NXsample.class.

Specified by:
getNXclass in interface NXobject
Returns:
name of Nexus class








getNexusBaseClass
public NexusBaseClass getNexusBaseClass()
Description copied from interface: NXobject
Enum constant from NexusBaseClass for this base class, e.g. NexusBaseClass.NX_SAMPLE.

Specified by:
getNexusBaseClass in interface NXobject
Returns:
NexusBaseClass enum constant for this class








getPermittedChildGroupClasses
public java.util.Set<NexusBaseClass> getPermittedChildGroupClasses()
Description copied from interface: NXobject
Returns a set containing the NexusBaseClass constants for the permitted child group types
 of this base class.

Specified by:
getPermittedChildGroupClasses in interface NXobject
Returns:
NexusBaseClass constants for permitted child groups








getAttributeDefault
public java.lang.String getAttributeDefault()
Description copied from interface: NXsubentry
.. index:: plotting
 Declares which :ref:`NXdata` 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.
 See http://wiki.nexusformat.org/2014_How_to_find_default_data
 for a summary of the discussion.

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








setAttributeDefault
public void setAttributeDefault(java.lang.String default_)
Description copied from interface: NXsubentry
.. index:: plotting
 Declares which :ref:`NXdata` 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.
 See http://wiki.nexusformat.org/2014_How_to_find_default_data
 for a summary of the discussion.

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








getAttributeIDF_Version
public java.lang.String getAttributeIDF_Version()
Description copied from interface: NXsubentry
ISIS Muon IDF_Version

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








setAttributeIDF_Version
public void setAttributeIDF_Version(java.lang.String IDF_Version)
Description copied from interface: NXsubentry
ISIS Muon IDF_Version

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








getTitle
public IDataset getTitle()
Description copied from interface: NXsubentry
Extended title for entry

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








getTitleScalar
public java.lang.String getTitleScalar()
Description copied from interface: NXsubentry
Extended title for entry

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








setTitle
public DataNode setTitle(IDataset title)
Description copied from interface: NXsubentry
Extended title for entry

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








setTitleScalar
public DataNode setTitleScalar(java.lang.String title)
Description copied from interface: NXsubentry
Extended title for entry

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








getExperiment_identifier
public IDataset getExperiment_identifier()
Description copied from interface: NXsubentry
Unique identifier for the experiment, defined by
 the facility, possibly linked to the proposals

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








getExperiment_identifierScalar
public java.lang.String getExperiment_identifierScalar()
Description copied from interface: NXsubentry
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_identifier
public DataNode setExperiment_identifier(IDataset experiment_identifier)
Description copied from interface: NXsubentry
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








setExperiment_identifierScalar
public DataNode setExperiment_identifierScalar(java.lang.String experiment_identifier)
Description copied from interface: NXsubentry
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
public IDataset getExperiment_description()
Description copied from interface: NXsubentry
Brief summary of the experiment, including key objectives.

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








getExperiment_descriptionScalar
public java.lang.String getExperiment_descriptionScalar()
Description copied from interface: NXsubentry
Brief summary of the experiment, including key objectives.

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








setExperiment_description
public DataNode setExperiment_description(IDataset experiment_description)
Description copied from interface: NXsubentry
Brief summary of the experiment, including key objectives.

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








setExperiment_descriptionScalar
public DataNode setExperiment_descriptionScalar(java.lang.String experiment_description)
Description copied from interface: NXsubentry
Brief summary of the experiment, including key objectives.

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








getExperiment_documentation
public NXnote getExperiment_documentation()
Description copied from interface: NXsubentry
Description of the full experiment (document in pdf, latex, ...)

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








setExperiment_documentation
public void setExperiment_documentation(NXnote experiment_documentation)
Description copied from interface: NXsubentry
Description of the full experiment (document in pdf, latex, ...)

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








getCollection_identifier
public IDataset getCollection_identifier()
Description copied from interface: NXsubentry
User or Data Acquisition defined group of NeXus files or :ref:`NXentry`

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








getCollection_identifierScalar
public java.lang.String getCollection_identifierScalar()
Description copied from interface: NXsubentry
User or Data Acquisition defined group of NeXus files or :ref:`NXentry`

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








setCollection_identifier
public DataNode setCollection_identifier(IDataset collection_identifier)
Description copied from interface: NXsubentry
User or Data Acquisition defined group of NeXus files or :ref:`NXentry`

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








setCollection_identifierScalar
public DataNode setCollection_identifierScalar(java.lang.String collection_identifier)
Description copied from interface: NXsubentry
User or Data Acquisition defined group of NeXus files or :ref:`NXentry`

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








getCollection_description
public IDataset getCollection_description()
Description copied from interface: NXsubentry
Brief summary of the collection, including grouping criteria.

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








getCollection_descriptionScalar
public java.lang.String getCollection_descriptionScalar()
Description copied from interface: NXsubentry
Brief summary of the collection, including grouping criteria.

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








setCollection_description
public DataNode setCollection_description(IDataset collection_description)
Description copied from interface: NXsubentry
Brief summary of the collection, including grouping criteria.

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








setCollection_descriptionScalar
public DataNode setCollection_descriptionScalar(java.lang.String collection_description)
Description copied from interface: NXsubentry
Brief summary of the collection, including grouping criteria.

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








getEntry_identifier
public IDataset getEntry_identifier()
Description copied from interface: NXsubentry
unique identifier for the measurement, defined by the facility.

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








getEntry_identifierScalar
public java.lang.String getEntry_identifierScalar()
Description copied from interface: NXsubentry
unique identifier for the measurement, defined by the facility.

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








setEntry_identifier
public DataNode setEntry_identifier(IDataset entry_identifier)
Description copied from interface: NXsubentry
unique identifier for the measurement, defined by the facility.

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








setEntry_identifierScalar
public DataNode setEntry_identifierScalar(java.lang.String entry_identifier)
Description copied from interface: NXsubentry
unique identifier for the measurement, defined by the facility.

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








getDefinition
public IDataset getDefinition()
Description copied from interface: NXsubentry
Official NeXus NXDL schema to which this subentry conforms

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








getDefinitionScalar
public java.lang.String getDefinitionScalar()
Description copied from interface: NXsubentry
Official NeXus NXDL schema to which this subentry conforms

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








setDefinition
public DataNode setDefinition(IDataset definition)
Description copied from interface: NXsubentry
Official NeXus NXDL schema to which this subentry conforms

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








setDefinitionScalar
public DataNode setDefinitionScalar(java.lang.String definition)
Description copied from interface: NXsubentry
Official NeXus NXDL schema to which this subentry conforms

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








getDefinitionAttributeVersion
public java.lang.String getDefinitionAttributeVersion()
Description copied from interface: NXsubentry
NXDL version number

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








setDefinitionAttributeVersion
public void setDefinitionAttributeVersion(java.lang.String version)
Description copied from interface: NXsubentry
NXDL version number

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








getDefinitionAttributeURL
public java.lang.String getDefinitionAttributeURL()
Description copied from interface: NXsubentry
URL of NXDL file

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








setDefinitionAttributeURL
public void setDefinitionAttributeURL(java.lang.String URL)
Description copied from interface: NXsubentry
URL of NXDL file

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








getDefinition_local
public IDataset getDefinition_local()
Description copied from interface: NXsubentry
Local NXDL schema extended from the subentry
 specified in the ``definition`` field.
 This contains any locally-defined,
 additional fields in the subentry.

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








getDefinition_localScalar
public java.lang.String getDefinition_localScalar()
Description copied from interface: NXsubentry
Local NXDL schema extended from the subentry
 specified in the ``definition`` field.
 This contains any locally-defined,
 additional fields in the subentry.

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








setDefinition_local
public DataNode setDefinition_local(IDataset definition_local)
Description copied from interface: NXsubentry
Local NXDL schema extended from the subentry
 specified in the ``definition`` field.
 This contains any locally-defined,
 additional fields in the subentry.

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








setDefinition_localScalar
public DataNode setDefinition_localScalar(java.lang.String definition_local)
Description copied from interface: NXsubentry
Local NXDL schema extended from the subentry
 specified in the ``definition`` field.
 This contains any locally-defined,
 additional fields in the subentry.

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








getDefinition_localAttributeVersion
public java.lang.String getDefinition_localAttributeVersion()
Description copied from interface: NXsubentry
NXDL version number

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








setDefinition_localAttributeVersion
public void setDefinition_localAttributeVersion(java.lang.String version)
Description copied from interface: NXsubentry
NXDL version number

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








getDefinition_localAttributeURL
public java.lang.String getDefinition_localAttributeURL()
Description copied from interface: NXsubentry
URL of NXDL file

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








setDefinition_localAttributeURL
public void setDefinition_localAttributeURL(java.lang.String URL)
Description copied from interface: NXsubentry
URL of NXDL file

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








getStart_time
public IDataset getStart_time()
Description copied from interface: NXsubentry
Starting time of measurement
 

 Type: NX_DATE_TIME
 

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








getStart_timeScalar
public java.util.Date getStart_timeScalar()
Description copied from interface: NXsubentry
Starting time of measurement
 

 Type: NX_DATE_TIME
 

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








setStart_time
public DataNode setStart_time(IDataset start_time)
Description copied from interface: NXsubentry
Starting time of measurement
 

 Type: NX_DATE_TIME
 

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








setStart_timeScalar
public DataNode setStart_timeScalar(java.util.Date start_time)
Description copied from interface: NXsubentry
Starting time of measurement
 

 Type: NX_DATE_TIME
 

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








getEnd_time
public IDataset getEnd_time()
Description copied from interface: NXsubentry
Ending time of measurement
 

 Type: NX_DATE_TIME
 

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








getEnd_timeScalar
public java.util.Date getEnd_timeScalar()
Description copied from interface: NXsubentry
Ending time of measurement
 

 Type: NX_DATE_TIME
 

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








setEnd_time
public DataNode setEnd_time(IDataset end_time)
Description copied from interface: NXsubentry
Ending time of measurement
 

 Type: NX_DATE_TIME
 

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








setEnd_timeScalar
public DataNode setEnd_timeScalar(java.util.Date end_time)
Description copied from interface: NXsubentry
Ending time of measurement
 

 Type: NX_DATE_TIME
 

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








getDuration
public IDataset getDuration()
Description copied from interface: NXsubentry
Duration of measurement
 

 Type: NX_INT
 Units: NX_TIME
 

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








getDurationScalar
public java.lang.Long getDurationScalar()
Description copied from interface: NXsubentry
Duration of measurement
 

 Type: NX_INT
 Units: NX_TIME
 

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








setDuration
public DataNode setDuration(IDataset duration)
Description copied from interface: NXsubentry
Duration of measurement
 

 Type: NX_INT
 Units: NX_TIME
 

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








setDurationScalar
public DataNode setDurationScalar(java.lang.Long duration)
Description copied from interface: NXsubentry
Duration of measurement
 

 Type: NX_INT
 Units: NX_TIME
 

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








getCollection_time
public IDataset getCollection_time()
Description copied from interface: NXsubentry
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.








getCollection_timeScalar
public java.lang.Double getCollection_timeScalar()
Description copied from interface: NXsubentry
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_time
public DataNode setCollection_time(IDataset collection_time)
Description copied from interface: NXsubentry
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








setCollection_timeScalar
public DataNode setCollection_timeScalar(java.lang.Double collection_time)
Description copied from interface: NXsubentry
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
public IDataset getRun_cycle()
Description copied from interface: NXsubentry
Such as "2007-3". Some user facilities organize their beam time into run cycles.

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








getRun_cycleScalar
public java.lang.String getRun_cycleScalar()
Description copied from interface: NXsubentry
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_cycle
public DataNode setRun_cycle(IDataset run_cycle)
Description copied from interface: NXsubentry
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








setRun_cycleScalar
public DataNode setRun_cycleScalar(java.lang.String run_cycle)
Description copied from interface: NXsubentry
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
public IDataset getProgram_name()
Description copied from interface: NXsubentry
Name of program used to generate this file

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








getProgram_nameScalar
public java.lang.String getProgram_nameScalar()
Description copied from interface: NXsubentry
Name of program used to generate this file

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








setProgram_name
public DataNode setProgram_name(IDataset program_name)
Description copied from interface: NXsubentry
Name of program used to generate this file

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








setProgram_nameScalar
public DataNode setProgram_nameScalar(java.lang.String program_name)
Description copied from interface: NXsubentry
Name of program used to generate this file

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








getProgram_nameAttributeVersion
public java.lang.String getProgram_nameAttributeVersion()
Description copied from interface: NXsubentry
Program version number

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








setProgram_nameAttributeVersion
public void setProgram_nameAttributeVersion(java.lang.String version)
Description copied from interface: NXsubentry
Program version number

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








getProgram_nameAttributeConfiguration
public java.lang.String getProgram_nameAttributeConfiguration()
Description copied from interface: NXsubentry
configuration of the program

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








setProgram_nameAttributeConfiguration
public void setProgram_nameAttributeConfiguration(java.lang.String configuration)
Description copied from interface: NXsubentry
configuration of the program

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








getRevision
public IDataset getRevision()
Description copied from interface: NXsubentry
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.








getRevisionScalar
public java.lang.String getRevisionScalar()
Description copied from interface: NXsubentry
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.








setRevision
public DataNode setRevision(IDataset revision)
Description copied from interface: NXsubentry
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








setRevisionScalar
public DataNode setRevisionScalar(java.lang.String revision)
Description copied from interface: NXsubentry
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
public java.lang.String getRevisionAttributeComment()

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








setRevisionAttributeComment
public void setRevisionAttributeComment(java.lang.String comment)

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








getPre_sample_flightpath
public IDataset getPre_sample_flightpath()
Description copied from interface: NXsubentry
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.








getPre_sample_flightpathScalar
public java.lang.Double getPre_sample_flightpathScalar()
Description copied from interface: NXsubentry
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_flightpath
public DataNode setPre_sample_flightpath(IDataset pre_sample_flightpath)
Description copied from interface: NXsubentry
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








setPre_sample_flightpathScalar
public DataNode setPre_sample_flightpathScalar(java.lang.Double pre_sample_flightpath)
Description copied from interface: NXsubentry
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
public NXnote getNotes()
Description copied from interface: NXsubentry
Notes describing entry

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








setNotes
public void setNotes(NXnote notes)
Description copied from interface: NXsubentry
Notes describing entry

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








getThumbnail
public NXnote getThumbnail()
Description copied from interface: NXsubentry
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
public void setThumbnail(NXnote thumbnail)
Description copied from interface: NXsubentry
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
public NXuser getUser()

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








setUser
public void setUser(NXuser user)

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








getUser
public NXuser getUser(java.lang.String name)
Description copied from interface: NXsubentry
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
public void setUser(java.lang.String name,
                    NXuser user)
Description copied from interface: NXsubentry
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
public java.util.Map<java.lang.String,NXuser> getAllUser()
Description copied from interface: NXsubentry
Get all NXuser nodes:
 

 

 

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








setAllUser
public void setAllUser(java.util.Map<java.lang.String,NXuser> user)
Description copied from interface: NXsubentry
Set multiple child nodes of a particular type.
 

 

 

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








getSample
public NXsample getSample()

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








setSample
public void setSample(NXsample sample)

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








getSample
public NXsample getSample(java.lang.String name)
Description copied from interface: NXsubentry
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
public void setSample(java.lang.String name,
                      NXsample sample)
Description copied from interface: NXsubentry
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
public java.util.Map<java.lang.String,NXsample> getAllSample()
Description copied from interface: NXsubentry
Get all NXsample nodes:
 

 

 

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








setAllSample
public void setAllSample(java.util.Map<java.lang.String,NXsample> sample)
Description copied from interface: NXsubentry
Set multiple child nodes of a particular type.
 

 

 

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








getInstrument
public NXinstrument getInstrument()

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








setInstrument
public void setInstrument(NXinstrument instrument)

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








getInstrument
public NXinstrument getInstrument(java.lang.String name)
Description copied from interface: NXsubentry
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
public void setInstrument(java.lang.String name,
                          NXinstrument instrument)
Description copied from interface: NXsubentry
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
public java.util.Map<java.lang.String,NXinstrument> getAllInstrument()
Description copied from interface: NXsubentry
Get all NXinstrument nodes:
 

 

 

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








setAllInstrument
public void setAllInstrument(java.util.Map<java.lang.String,NXinstrument> instrument)
Description copied from interface: NXsubentry
Set multiple child nodes of a particular type.
 

 

 

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








getCollection
public NXcollection getCollection()

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








setCollection
public void setCollection(NXcollection collection)

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








getCollection
public NXcollection getCollection(java.lang.String name)
Description copied from interface: NXsubentry
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
public void setCollection(java.lang.String name,
                          NXcollection collection)
Description copied from interface: NXsubentry
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
public java.util.Map<java.lang.String,NXcollection> getAllCollection()
Description copied from interface: NXsubentry
Get all NXcollection nodes:
 

 

 

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








setAllCollection
public void setAllCollection(java.util.Map<java.lang.String,NXcollection> collection)
Description copied from interface: NXsubentry
Set multiple child nodes of a particular type.
 

 

 

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








getMonitor
public NXmonitor getMonitor()

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








setMonitor
public void setMonitor(NXmonitor monitor)

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








getMonitor
public NXmonitor getMonitor(java.lang.String name)
Description copied from interface: NXsubentry
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
public void setMonitor(java.lang.String name,
                       NXmonitor monitor)
Description copied from interface: NXsubentry
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
public java.util.Map<java.lang.String,NXmonitor> getAllMonitor()
Description copied from interface: NXsubentry
Get all NXmonitor nodes:
 

 

 

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








setAllMonitor
public void setAllMonitor(java.util.Map<java.lang.String,NXmonitor> monitor)
Description copied from interface: NXsubentry
Set multiple child nodes of a particular type.
 

 

 

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








getData
public NXdata getData()

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








setData
public void setData(NXdata data)

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








getData
public NXdata getData(java.lang.String name)
Description copied from interface: NXsubentry
Get a NXdata node by name:
 

 

 

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
public void setData(java.lang.String name,
                    NXdata data)
Description copied from interface: NXsubentry
Set a NXdata node by name:
 

 

 

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








getAllData
public java.util.Map<java.lang.String,NXdata> getAllData()
Description copied from interface: NXsubentry
Get all NXdata nodes:
 

 

 

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








setAllData
public void setAllData(java.util.Map<java.lang.String,NXdata> data)
Description copied from interface: NXsubentry
Set multiple child nodes of a particular type.
 

 

 

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








getParameters
public NXparameters getParameters()

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








setParameters
public void setParameters(NXparameters parameters)

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








getParameters
public NXparameters getParameters(java.lang.String name)
Description copied from interface: NXsubentry
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
public void setParameters(java.lang.String name,
                          NXparameters parameters)
Description copied from interface: NXsubentry
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
public java.util.Map<java.lang.String,NXparameters> getAllParameters()
Description copied from interface: NXsubentry
Get all NXparameters nodes:
 

 

 

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








setAllParameters
public void setAllParameters(java.util.Map<java.lang.String,NXparameters> parameters)
Description copied from interface: NXsubentry
Set multiple child nodes of a particular type.
 

 

 

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








getProcess
public NXprocess getProcess()

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








setProcess
public void setProcess(NXprocess process)

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








getProcess
public NXprocess getProcess(java.lang.String name)
Description copied from interface: NXsubentry
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
public void setProcess(java.lang.String name,
                       NXprocess process)
Description copied from interface: NXsubentry
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
public java.util.Map<java.lang.String,NXprocess> getAllProcess()
Description copied from interface: NXsubentry
Get all NXprocess nodes:
 

 

 

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








setAllProcess
public void setAllProcess(java.util.Map<java.lang.String,NXprocess> process)
Description copied from interface: NXsubentry
Set multiple child nodes of a particular type.
 

 

 

Specified by:
setAllProcess in interface NXsubentry
Parameters:
process - 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