All Downloads are FREE. Search and download functionalities are using the official Maven repository.

generated.docs.javadoc.org.eclipse.dawnsci.nexus.impl.NXentryImpl.html Maven / Gradle / Ivy

Go to download 






NXentryImpl (h5jan API)













Skip navigation links
































org.eclipse.dawnsci.nexus.impl


Class NXentryImpl









    

  • 

    

    All Implemented Interfaces:
    

    java.io.Serializable, java.lang.Iterable<NodeLink>, GroupNode, Node, NXentry, NXobject, NXsubentry
    

    

    

    

    public class NXentryImpl
extends NXobjectImpl
implements NXentry
    

    (**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.
    

    

    See Also:
    

    Serialized Form
    

    

    • 












    

  • 


      

    • 



      Field Detail
      




        

      • 

        PERMITTED_CHILD_GROUP_CLASSES
        

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

        • 

      

      • 

    


      

    • 



      Constructor Detail
      




        

      • 

        NXentryImpl
        

        public NXentryImpl()
        

        • 

      




        

      • 

        NXentryImpl
        

        public NXentryImpl(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
        

        

        • 

      












        

      • 

        getAttributeDefault
        

        public java.lang.String getAttributeDefault()
        

        Description copied from interface: NXentry
        

        .. 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 NXentry
        

        Specified by:
        

        getAttributeDefault in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        setAttributeDefault
        

        public void setAttributeDefault(java.lang.String default_)
        

        Description copied from interface: NXentry
        

        .. 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 NXentry
        

        Specified by:
        

        setAttributeDefault in interface NXsubentry
        

        Parameters:
        

        default_ - the default
        

        

        • 

      




        

      • 

        getData
        

        public NXdata getData()
        

        Description copied from interface: NXentry
        

        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 NXentry
        

        Specified by:
        

        getData in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        setData
        

        public void setData(NXdata data)
        

        Description copied from interface: NXentry
        

        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 NXentry
        

        Specified by:
        

        setData in interface NXsubentry
        

        Parameters:
        

        data - the data
        

        

        • 

      




        

      • 

        getData
        

        public NXdata getData(java.lang.String name)
        

        Description copied from interface: NXentry
        

        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 NXentry
        

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

        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 NXentry
        

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

        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 NXentry
        

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

        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 NXentry
        

        Specified by:
        

        setAllData in interface NXsubentry
        

        Parameters:
        

        data - the child nodes to add
        

        

        • 

      












        

      • 

        getTitle
        

        public IDataset getTitle()
        

        Description copied from interface: NXentry
        

        Extended title for entry
        

        

        Specified by:
        

        getTitle in interface NXentry
        

        Specified by:
        

        getTitle in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      








        

      • 

        setTitle
        

        public DataNode setTitle(IDataset title)
        

        Description copied from interface: NXentry
        

        Extended title for entry
        

        

        Specified by:
        

        setTitle in interface NXentry
        

        Specified by:
        

        setTitle in interface NXsubentry
        

        Parameters:
        

        title - the title
        

        

        • 

      
















        

      • 

        setExperiment_identifier
        

        public DataNode setExperiment_identifier(IDataset experiment_identifier)
        

        Description copied from interface: NXentry
        

        Unique identifier for the experiment,
 defined by the facility,
 possibly linked to the proposals
        

        

        Specified by:
        

        setExperiment_identifier in interface NXentry
        

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

        Unique identifier for the experiment,
 defined by the facility,
 possibly linked to the proposals
        

        

        Specified by:
        

        setExperiment_identifierScalar in interface NXentry
        

        Specified by:
        

        setExperiment_identifierScalar in interface NXsubentry
        

        Parameters:
        

        experiment_identifier - the experiment_identifier
        

        

        • 

      




































        

      • 

        setCollection_identifier
        

        public DataNode setCollection_identifier(IDataset collection_identifier)
        

        Description copied from interface: NXentry
        

        User or Data Acquisition defined group of NeXus files or NXentry
        

        

        Specified by:
        

        setCollection_identifier in interface NXentry
        

        Specified by:
        

        setCollection_identifier in interface NXsubentry
        

        Parameters:
        

        collection_identifier - the collection_identifier
        

        

        • 

      
































        

      • 

        setEntry_identifier
        

        public DataNode setEntry_identifier(IDataset entry_identifier)
        

        Description copied from interface: NXentry
        

        unique identifier for the measurement, defined by the facility.
        

        

        Specified by:
        

        setEntry_identifier in interface NXentry
        

        Specified by:
        

        setEntry_identifier in interface NXsubentry
        

        Parameters:
        

        entry_identifier - the entry_identifier
        

        

        • 

      








        

      • 

        getFeatures
        

        public IDataset getFeatures()
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        getFeatures in interface NXentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        getFeaturesScalar
        

        public java.lang.String getFeaturesScalar()
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        getFeaturesScalar in interface NXentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        setFeatures
        

        public DataNode setFeatures(IDataset features)
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        setFeatures in interface NXentry
        

        Parameters:
        

        features - the features
        

        

        • 

      




        

      • 

        setFeaturesScalar
        

        public DataNode setFeaturesScalar(java.lang.String features)
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        setFeaturesScalar in interface NXentry
        

        Parameters:
        

        features - the features
        

        

        • 

      




        

      • 

        getDefinition
        

        public IDataset getDefinition()
        

        Description copied from interface: NXentry
        

        (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 NXentry
        

        Specified by:
        

        getDefinition in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        getDefinitionScalar
        

        public java.lang.String getDefinitionScalar()
        

        Description copied from interface: NXentry
        

        (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 NXentry
        

        Specified by:
        

        getDefinitionScalar in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        setDefinition
        

        public DataNode setDefinition(IDataset definition)
        

        Description copied from interface: NXentry
        

        (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 NXentry
        

        Specified by:
        

        setDefinition in interface NXsubentry
        

        Parameters:
        

        definition - the definition
        

        

        • 

      




        

      • 

        setDefinitionScalar
        

        public DataNode setDefinitionScalar(java.lang.String definition)
        

        Description copied from interface: NXentry
        

        (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 NXentry
        

        Specified by:
        

        setDefinitionScalar in interface NXsubentry
        

        Parameters:
        

        definition - the definition
        

        

        • 

      




















        

      • 

        getDefinition_local
        

        @Deprecated
public IDataset getDefinition_local()
        

        Deprecated. 
        

        Description copied from interface: NXentry
        

        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 NXentry
        

        Specified by:
        

        getDefinition_local in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        getDefinition_localScalar
        

        @Deprecated
public java.lang.String getDefinition_localScalar()
        

        Deprecated. 
        

        Description copied from interface: NXentry
        

        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 NXentry
        

        Specified by:
        

        getDefinition_localScalar in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        setDefinition_local
        

        @Deprecated
public DataNode setDefinition_local(IDataset definition_local)
        

        Deprecated. 
        

        Description copied from interface: NXentry
        

        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 NXentry
        

        Specified by:
        

        setDefinition_local in interface NXsubentry
        

        Parameters:
        

        definition_local - the definition_local
        

        

        • 

      




        

      • 

        setDefinition_localScalar
        

        @Deprecated
public DataNode setDefinition_localScalar(java.lang.String definition_local)
        

        Deprecated. 
        

        Description copied from interface: NXentry
        

        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 NXentry
        

        Specified by:
        

        setDefinition_localScalar in interface NXsubentry
        

        Parameters:
        

        definition_local - the definition_local
        

        

        • 

      




















        

      • 

        getStart_time
        

        public IDataset getStart_time()
        

        Description copied from interface: NXentry
        

        Starting time of measurement
 
        
 Type: NX_DATE_TIME
 
        

        

        Specified by:
        

        getStart_time in interface NXentry
        

        Specified by:
        

        getStart_time in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      








        

      • 

        setStart_time
        

        public DataNode setStart_time(IDataset start_time)
        

        Description copied from interface: NXentry
        

        Starting time of measurement
 
        
 Type: NX_DATE_TIME
 
        

        

        Specified by:
        

        setStart_time in interface NXentry
        

        Specified by:
        

        setStart_time in interface NXsubentry
        

        Parameters:
        

        start_time - the start_time
        

        

        • 

      








        

      • 

        getEnd_time
        

        public IDataset getEnd_time()
        

        Description copied from interface: NXentry
        

        Ending time of measurement
 
        
 Type: NX_DATE_TIME
 
        

        

        Specified by:
        

        getEnd_time in interface NXentry
        

        Specified by:
        

        getEnd_time in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      








        

      • 

        setEnd_time
        

        public DataNode setEnd_time(IDataset end_time)
        

        Description copied from interface: NXentry
        

        Ending time of measurement
 
        
 Type: NX_DATE_TIME
 
        

        

        Specified by:
        

        setEnd_time in interface NXentry
        

        Specified by:
        

        setEnd_time in interface NXsubentry
        

        Parameters:
        

        end_time - the end_time
        

        

        • 

      








        

      • 

        getDuration
        

        public IDataset getDuration()
        

        Description copied from interface: NXentry
        

        Duration of measurement
 
        
 Type: NX_INT
 Units: NX_TIME
 
        

        

        Specified by:
        

        getDuration in interface NXentry
        

        Specified by:
        

        getDuration in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        getDurationScalar
        

        public java.lang.Long getDurationScalar()
        

        Description copied from interface: NXentry
        

        Duration of measurement
 
        
 Type: NX_INT
 Units: NX_TIME
 
        

        

        Specified by:
        

        getDurationScalar in interface NXentry
        

        Specified by:
        

        getDurationScalar in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        setDuration
        

        public DataNode setDuration(IDataset duration)
        

        Description copied from interface: NXentry
        

        Duration of measurement
 
        
 Type: NX_INT
 Units: NX_TIME
 
        

        

        Specified by:
        

        setDuration in interface NXentry
        

        Specified by:
        

        setDuration in interface NXsubentry
        

        Parameters:
        

        duration - the duration
        

        

        • 

      








        

      • 

        getCollection_time
        

        public IDataset getCollection_time()
        

        Description copied from interface: NXentry
        

        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 NXentry
        

        Specified by:
        

        getCollection_time in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        getCollection_timeScalar
        

        public java.lang.Double getCollection_timeScalar()
        

        Description copied from interface: NXentry
        

        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 NXentry
        

        Specified by:
        

        getCollection_timeScalar in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        setCollection_time
        

        public DataNode setCollection_time(IDataset collection_time)
        

        Description copied from interface: NXentry
        

        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 NXentry
        

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

        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 NXentry
        

        Specified by:
        

        setCollection_timeScalar in interface NXsubentry
        

        Parameters:
        

        collection_time - the collection_time
        

        

        • 

      




        

      • 

        getRun_cycle
        

        public IDataset getRun_cycle()
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        getRun_cycle in interface NXentry
        

        Specified by:
        

        getRun_cycle in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        getRun_cycleScalar
        

        public java.lang.String getRun_cycleScalar()
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        getRun_cycleScalar in interface NXentry
        

        Specified by:
        

        getRun_cycleScalar in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        setRun_cycle
        

        public DataNode setRun_cycle(IDataset run_cycle)
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        setRun_cycle in interface NXentry
        

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

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

        

        Specified by:
        

        setRun_cycleScalar in interface NXentry
        

        Specified by:
        

        setRun_cycleScalar in interface NXsubentry
        

        Parameters:
        

        run_cycle - the run_cycle
        

        

        • 

      












        

      • 

        setProgram_name
        

        public DataNode setProgram_name(IDataset program_name)
        

        Description copied from interface: NXentry
        

        Name of program used to generate this file
        

        

        Specified by:
        

        setProgram_name in interface NXentry
        

        Specified by:
        

        setProgram_name in interface NXsubentry
        

        Parameters:
        

        program_name - the program_name
        

        

        • 

      
























        

      • 

        getRevision
        

        public IDataset getRevision()
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        getRevision in interface NXentry
        

        Specified by:
        

        getRevision in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        getRevisionScalar
        

        public java.lang.String getRevisionScalar()
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        getRevisionScalar in interface NXentry
        

        Specified by:
        

        getRevisionScalar in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        setRevision
        

        public DataNode setRevision(IDataset revision)
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        setRevision in interface NXentry
        

        Specified by:
        

        setRevision in interface NXsubentry
        

        Parameters:
        

        revision - the revision
        

        

        • 

      




        

      • 

        setRevisionScalar
        

        public DataNode setRevisionScalar(java.lang.String revision)
        

        Description copied from interface: NXentry
        

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

        

        Specified by:
        

        setRevisionScalar in interface NXentry
        

        Specified by:
        

        setRevisionScalar in interface NXsubentry
        

        Parameters:
        

        revision - the revision
        

        

        • 

      












        

      • 

        getPre_sample_flightpath
        

        public IDataset getPre_sample_flightpath()
        

        Description copied from interface: NXentry
        

        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 NXentry
        

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

        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 NXentry
        

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

        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 NXentry
        

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

        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 NXentry
        

        Specified by:
        

        setPre_sample_flightpathScalar in interface NXsubentry
        

        Parameters:
        

        pre_sample_flightpath - the pre_sample_flightpath
        

        

        • 

      








        

      • 

        setNotes
        

        public void setNotes(NXnote notes)
        

        Description copied from interface: NXentry
        

        Notes describing entry
        

        

        Specified by:
        

        setNotes in interface NXentry
        

        Specified by:
        

        setNotes in interface NXsubentry
        

        Parameters:
        

        notes - the notes
        

        

        • 

      




        

      • 

        getThumbnail
        

        public NXnote getThumbnail()
        

        Description copied from interface: NXentry
        

        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 NXentry
        

        Specified by:
        

        getThumbnail in interface NXsubentry
        

        Returns:
        

        the value.
        

        

        • 

      




        

      • 

        setThumbnail
        

        public void setThumbnail(NXnote thumbnail)
        

        Description copied from interface: NXentry
        

        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 NXentry
        

        Specified by:
        

        setThumbnail in interface NXsubentry
        

        Parameters:
        

        thumbnail - the thumbnail
        

        

        • 

      












        

      • 

        getUser
        

        public NXuser getUser(java.lang.String name)
        

        Description copied from interface: NXentry
        

        Get a NXuser node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        getUser in interface NXentry
        

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

        Set a NXuser node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        setUser in interface NXentry
        

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

        Get all NXuser nodes:
 
          
 
        • 
 
        

        

        Specified by:
        

        getAllUser in interface NXentry
        

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

        Set multiple child nodes of a particular type.
 
          
 
        • 
 
        

        

        Specified by:
        

        setAllUser in interface NXentry
        

        Specified by:
        

        setAllUser in interface NXsubentry
        

        Parameters:
        

        user - the child nodes to add
        

        

        • 

      












        

      • 

        getSample
        

        public NXsample getSample(java.lang.String name)
        

        Description copied from interface: NXentry
        

        Get a NXsample node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        getSample in interface NXentry
        

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

        Set a NXsample node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        setSample in interface NXentry
        

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

        Get all NXsample nodes:
 
          
 
        • 
 
        

        

        Specified by:
        

        getAllSample in interface NXentry
        

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

        Set multiple child nodes of a particular type.
 
          
 
        • 
 
        

        

        Specified by:
        

        setAllSample in interface NXentry
        

        Specified by:
        

        setAllSample in interface NXsubentry
        

        Parameters:
        

        sample - the child nodes to add
        

        

        • 

      












        

      • 

        getInstrument
        

        public NXinstrument getInstrument(java.lang.String name)
        

        Description copied from interface: NXentry
        

        Get a NXinstrument node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        getInstrument in interface NXentry
        

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

        Set a NXinstrument node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        setInstrument in interface NXentry
        

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

        Get all NXinstrument nodes:
 
          
 
        • 
 
        

        

        Specified by:
        

        getAllInstrument in interface NXentry
        

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

        Set multiple child nodes of a particular type.
 
          
 
        • 
 
        

        

        Specified by:
        

        setAllInstrument in interface NXentry
        

        Specified by:
        

        setAllInstrument in interface NXsubentry
        

        Parameters:
        

        instrument - the child nodes to add
        

        

        • 

      












        

      • 

        getCollection
        

        public NXcollection getCollection(java.lang.String name)
        

        Description copied from interface: NXentry
        

        Get a NXcollection node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        getCollection in interface NXentry
        

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

        Set a NXcollection node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        setCollection in interface NXentry
        

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

        Get all NXcollection nodes:
 
          
 
        • 
 
        

        

        Specified by:
        

        getAllCollection in interface NXentry
        

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

        Set multiple child nodes of a particular type.
 
          
 
        • 
 
        

        

        Specified by:
        

        setAllCollection in interface NXentry
        

        Specified by:
        

        setAllCollection in interface NXsubentry
        

        Parameters:
        

        collection - the child nodes to add
        

        

        • 

      












        

      • 

        getMonitor
        

        public NXmonitor getMonitor(java.lang.String name)
        

        Description copied from interface: NXentry
        

        Get a NXmonitor node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        getMonitor in interface NXentry
        

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

        Set a NXmonitor node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        setMonitor in interface NXentry
        

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

        Get all NXmonitor nodes:
 
          
 
        • 
 
        

        

        Specified by:
        

        getAllMonitor in interface NXentry
        

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

        Set multiple child nodes of a particular type.
 
          
 
        • 
 
        

        

        Specified by:
        

        setAllMonitor in interface NXentry
        

        Specified by:
        

        setAllMonitor in interface NXsubentry
        

        Parameters:
        

        monitor - the child nodes to add
        

        

        • 

      












        

      • 

        getParameters
        

        public NXparameters getParameters(java.lang.String name)
        

        Description copied from interface: NXentry
        

        Get a NXparameters node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        getParameters in interface NXentry
        

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

        Set a NXparameters node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        setParameters in interface NXentry
        

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

        Get all NXparameters nodes:
 
          
 
        • 
 
        

        

        Specified by:
        

        getAllParameters in interface NXentry
        

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

        Set multiple child nodes of a particular type.
 
          
 
        • 
 
        

        

        Specified by:
        

        setAllParameters in interface NXentry
        

        Specified by:
        

        setAllParameters in interface NXsubentry
        

        Parameters:
        

        parameters - the child nodes to add
        

        

        • 

      












        

      • 

        getProcess
        

        public NXprocess getProcess(java.lang.String name)
        

        Description copied from interface: NXentry
        

        Get a NXprocess node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        getProcess in interface NXentry
        

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

        Set a NXprocess node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        setProcess in interface NXentry
        

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

        Get all NXprocess nodes:
 
          
 
        • 
 
        

        

        Specified by:
        

        getAllProcess in interface NXentry
        

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

        Set multiple child nodes of a particular type.
 
          
 
        • 
 
        

        

        Specified by:
        

        setAllProcess in interface NXentry
        

        Specified by:
        

        setAllProcess in interface NXsubentry
        

        Parameters:
        

        process - the child nodes to add
        

        

        • 

      








        

      • 

        setSubentry
        

        public void setSubentry(NXsubentry subentry)
        

        

        Specified by:
        

        setSubentry in interface NXentry
        

        Parameters:
        

        subentry - the subentry
        

        

        • 

      




        

      • 

        getSubentry
        

        public NXsubentry getSubentry(java.lang.String name)
        

        Description copied from interface: NXentry
        

        Get a NXsubentry node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        getSubentry in interface NXentry
        

        Parameters:
        

        name - the name of the node.
        

        Returns:
        

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

        

        • 

      




        

      • 

        setSubentry
        

        public void setSubentry(java.lang.String name,
                        NXsubentry subentry)
        

        Description copied from interface: NXentry
        

        Set a NXsubentry node by name:
 
          
 
        • 
 
        

        

        Specified by:
        

        setSubentry in interface NXentry
        

        Parameters:
        

        name - the name of the node
        

        subentry - the value to set
        

        

        • 

      




        

      • 

        getAllSubentry
        

        public java.util.Map<java.lang.String,NXsubentry> getAllSubentry()
        

        Description copied from interface: NXentry
        

        Get all NXsubentry nodes:
 
          
 
        • 
 
        

        

        Specified by:
        

        getAllSubentry in interface NXentry
        

        Returns:
        

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

        

        • 

      




        

      • 

        setAllSubentry
        

        public void setAllSubentry(java.util.Map<java.lang.String,NXsubentry> subentry)
        

        Description copied from interface: NXentry
        

        Set multiple child nodes of a particular type.
 
          
 
        • 
 
        

        

        Specified by:
        

        setAllSubentry in interface NXentry
        

        Parameters:
        

        subentry - the child nodes to add
        

        

        • 

      

      • 

    

    • 













Skip navigation links




© 2015 - 2024 Weber Informatics LLC | Privacy Policy