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






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


All Known Implementing Classes:
NXrootImpl




public interface NXroot
extends NXobject
Definition of the root NeXus group.











Field Summary

Fields 

Modifier and Type
Field and Description


static java.lang.String
NX_ATTRIBUTE_CREATOR 


static java.lang.String
NX_ATTRIBUTE_DEFAULT 


static java.lang.String
NX_ATTRIBUTE_FILE_NAME 


static java.lang.String
NX_ATTRIBUTE_FILE_TIME 


static java.lang.String
NX_ATTRIBUTE_FILE_UPDATE_TIME 


static java.lang.String
NX_ATTRIBUTE_H5PY_VERSION 


static java.lang.String
NX_ATTRIBUTE_HDF_VERSION 


static java.lang.String
NX_ATTRIBUTE_HDF5_VERSION 


static java.lang.String
NX_ATTRIBUTE_NEXUS_VERSION 


static java.lang.String
NX_ATTRIBUTE_NX_CLASS 


static java.lang.String
NX_ATTRIBUTE_XML_VERSION 






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








Method Summary

All Methods Instance Methods Abstract Methods 

Modifier and Type
Method and Description


java.util.Map<java.lang.String,NXentry>
getAllEntry()
Get all NXentry nodes:
 
 
 entries
 



java.lang.String
getAttributeCreator()
facility or program where file originated



java.lang.String
getAttributeDefault()
..



java.lang.String
getAttributeFile_name()
File name of original NeXus file



java.lang.String
getAttributeFile_time()
Date and time file was originally created



java.lang.String
getAttributeFile_update_time()
Date and time of last file change at close



java.lang.String
getAttributeH5py_version()
Version of h5py Python package used in writing the file



java.lang.String
getAttributeHDF_version()
Version of HDF (version 4) library used in writing the file



java.lang.String
getAttributeHDF5_Version()
Version of HDF5 library used in writing the file.



java.lang.String
getAttributeNeXus_version()
Version of NeXus API used in writing the file.



java.lang.String
getAttributeNX_class()
The root of any NeXus data file is an ``NXroot`` class
 (no other choice is allowed for a valid NeXus data file).



java.lang.String
getAttributeXML_version()
Version of XML support library used in writing the XML file



NXentry
getEntry()
entries



NXentry
getEntry(java.lang.String name)
Get a NXentry node by name:
 
 
 entries
 



void
setAllEntry(java.util.Map<java.lang.String,NXentry> entry)
Set multiple child nodes of a particular type.



void
setAttributeCreator(java.lang.String creator)
facility or program where file originated



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



void
setAttributeFile_name(java.lang.String file_name)
File name of original NeXus file



void
setAttributeFile_time(java.lang.String file_time)
Date and time file was originally created



void
setAttributeFile_update_time(java.lang.String file_update_time)
Date and time of last file change at close



void
setAttributeH5py_version(java.lang.String h5py_version)
Version of h5py Python package used in writing the file



void
setAttributeHDF_version(java.lang.String HDF_version)
Version of HDF (version 4) library used in writing the file



void
setAttributeHDF5_Version(java.lang.String HDF5_Version)
Version of HDF5 library used in writing the file.



void
setAttributeNeXus_version(java.lang.String NeXus_version)
Version of NeXus API used in writing the file.



void
setAttributeNX_class(java.lang.String NX_class)
The root of any NeXus data file is an ``NXroot`` class
 (no other choice is allowed for a valid NeXus data file).



void
setAttributeXML_version(java.lang.String XML_version)
Version of XML support library used in writing the XML file



void
setEntry(NXentry entry)
entries



void
setEntry(java.lang.String name,
        NXentry entry)
Set a NXentry node by name:
 
 
 entries
 







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_NX_CLASS
static final java.lang.String NX_ATTRIBUTE_NX_CLASS

See Also:
Constant Field Values








NX_ATTRIBUTE_FILE_TIME
static final java.lang.String NX_ATTRIBUTE_FILE_TIME

See Also:
Constant Field Values








NX_ATTRIBUTE_FILE_NAME
static final java.lang.String NX_ATTRIBUTE_FILE_NAME

See Also:
Constant Field Values








NX_ATTRIBUTE_FILE_UPDATE_TIME
static final java.lang.String NX_ATTRIBUTE_FILE_UPDATE_TIME

See Also:
Constant Field Values








NX_ATTRIBUTE_NEXUS_VERSION
static final java.lang.String NX_ATTRIBUTE_NEXUS_VERSION

See Also:
Constant Field Values








NX_ATTRIBUTE_HDF_VERSION
static final java.lang.String NX_ATTRIBUTE_HDF_VERSION

See Also:
Constant Field Values








NX_ATTRIBUTE_HDF5_VERSION
static final java.lang.String NX_ATTRIBUTE_HDF5_VERSION

See Also:
Constant Field Values








NX_ATTRIBUTE_XML_VERSION
static final java.lang.String NX_ATTRIBUTE_XML_VERSION

See Also:
Constant Field Values








NX_ATTRIBUTE_H5PY_VERSION
static final java.lang.String NX_ATTRIBUTE_H5PY_VERSION

See Also:
Constant Field Values








NX_ATTRIBUTE_CREATOR
static final java.lang.String NX_ATTRIBUTE_CREATOR

See Also:
Constant Field Values








NX_ATTRIBUTE_DEFAULT
static final java.lang.String NX_ATTRIBUTE_DEFAULT

See Also:
Constant Field Values










Method Detail





getAttributeNX_class
java.lang.String getAttributeNX_class()
The root of any NeXus data file is an ``NXroot`` class
 (no other choice is allowed for a valid NeXus data file).
 This attribute cements that definition.
 

 
Enumeration:

 
NXroot 

 


Returns:
the value.








setAttributeNX_class
void setAttributeNX_class(java.lang.String NX_class)
The root of any NeXus data file is an ``NXroot`` class
 (no other choice is allowed for a valid NeXus data file).
 This attribute cements that definition.
 

 
Enumeration:

 
NXroot 

 


Parameters:
NX_class - the NX_class








getAttributeFile_time
java.lang.String getAttributeFile_time()
Date and time file was originally created

Returns:
the value.








setAttributeFile_time
void setAttributeFile_time(java.lang.String file_time)
Date and time file was originally created

Parameters:
file_time - the file_time








getAttributeFile_name
java.lang.String getAttributeFile_name()
File name of original NeXus file

Returns:
the value.








setAttributeFile_name
void setAttributeFile_name(java.lang.String file_name)
File name of original NeXus file

Parameters:
file_name - the file_name








getAttributeFile_update_time
java.lang.String getAttributeFile_update_time()
Date and time of last file change at close

Returns:
the value.








setAttributeFile_update_time
void setAttributeFile_update_time(java.lang.String file_update_time)
Date and time of last file change at close

Parameters:
file_update_time - the file_update_time








getAttributeNeXus_version
java.lang.String getAttributeNeXus_version()
Version of NeXus API used in writing the file.
 Only used when the NAPI has written the file.
 Note that this is different from the version of the
 base class or application definition version number.

Returns:
the value.








setAttributeNeXus_version
void setAttributeNeXus_version(java.lang.String NeXus_version)
Version of NeXus API used in writing the file.
 Only used when the NAPI has written the file.
 Note that this is different from the version of the
 base class or application definition version number.

Parameters:
NeXus_version - the NeXus_version








getAttributeHDF_version
java.lang.String getAttributeHDF_version()
Version of HDF (version 4) library used in writing the file

Returns:
the value.








setAttributeHDF_version
void setAttributeHDF_version(java.lang.String HDF_version)
Version of HDF (version 4) library used in writing the file

Parameters:
HDF_version - the HDF_version








getAttributeHDF5_Version
java.lang.String getAttributeHDF5_Version()
Version of HDF5 library used in writing the file.
 Note this attribute is spelled with uppercase "V",
 different than other version attributes.

Returns:
the value.








setAttributeHDF5_Version
void setAttributeHDF5_Version(java.lang.String HDF5_Version)
Version of HDF5 library used in writing the file.
 Note this attribute is spelled with uppercase "V",
 different than other version attributes.

Parameters:
HDF5_Version - the HDF5_Version








getAttributeXML_version
java.lang.String getAttributeXML_version()
Version of XML support library used in writing the XML file

Returns:
the value.








setAttributeXML_version
void setAttributeXML_version(java.lang.String XML_version)
Version of XML support library used in writing the XML file

Parameters:
XML_version - the XML_version








getAttributeH5py_version
java.lang.String getAttributeH5py_version()
Version of h5py Python package used in writing the file

Returns:
the value.








setAttributeH5py_version
void setAttributeH5py_version(java.lang.String h5py_version)
Version of h5py Python package used in writing the file

Parameters:
h5py_version - the h5py_version








getAttributeCreator
java.lang.String getAttributeCreator()
facility or program where file originated

Returns:
the value.








setAttributeCreator
void setAttributeCreator(java.lang.String creator)
facility or program where file originated

Parameters:
creator - the creator








getEntry
NXentry getEntry()
entries

Returns:
the value.








setEntry
void setEntry(NXentry entry)
entries

Parameters:
entry - the entry








getEntry
NXentry getEntry(java.lang.String name)
Get a NXentry node by name:
 

 

 entries
 

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








setEntry
void setEntry(java.lang.String name,
              NXentry entry)
Set a NXentry node by name:
 

 

 entries
 

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








getAllEntry
java.util.Map<java.lang.String,NXentry> getAllEntry()
Get all NXentry nodes:
 

 

 entries
 

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








setAllEntry
void setAllEntry(java.util.Map<java.lang.String,NXentry> entry)
Set multiple child nodes of a particular type.
 

 

 entries
 

Parameters:
entry - the child nodes to add








getAttributeDefault
java.lang.String getAttributeDefault()
.. index:: plotting
 Declares which :ref:`NXentry` group contains
 the data to be shown by default.
 It is needed to resolve ambiguity when
 more than one :ref:`NXentry` group exists.
 The value is the name of the default :ref:`NXentry` 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.

Returns:
the value.








setAttributeDefault
void setAttributeDefault(java.lang.String default_)
.. index:: plotting
 Declares which :ref:`NXentry` group contains
 the data to be shown by default.
 It is needed to resolve ambiguity when
 more than one :ref:`NXentry` group exists.
 The value is the name of the default :ref:`NXentry` 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.

Parameters:
default_ - the default














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