Package org.eclipse.dawnsci.nexus

Interface NXentry

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

  • Field Details

  • Method Details

    • getData

      NXdata getData()
      The data group .. note:: Before the NIAC2016 meeting [#]_, at least one :ref:`NXdata` group was required in each :ref:`NXentry` group. At the NIAC2016 meeting, it was decided to make :ref:`NXdata` an optional group in :ref:`NXentry` groups for data files that do not use an application definition. It is recommended strongly that all NeXus data files provide a NXdata group. It is permissible 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: https://www.nexusformat.org/NIAC2016.html, https://github.com/nexusformat/NIAC/issues/16
      Specified by:
      getData in interface NXsubentry
      Returns:
      the value.

    • setData

      void setData(NXdata dataGroup)
      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 permissible 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: https://www.nexusformat.org/NIAC2016.html, https://github.com/nexusformat/NIAC/issues/16
      Specified by:
      setData in interface NXsubentry
      Parameters:
      dataGroup - the dataGroup

    • getData

      NXdata getData(String name)
      Get a NXdata node by name:
      • The data group .. note:: Before the NIAC2016 meeting [#]_, at least one :ref:`NXdata` group was required in each :ref:`NXentry` group. At the NIAC2016 meeting, it was decided to make :ref:`NXdata` an optional group in :ref:`NXentry` groups for data files that do not use an application definition. It is recommended strongly that all NeXus data files provide a NXdata group. It is permissible 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: https://www.nexusformat.org/NIAC2016.html, https://github.com/nexusformat/NIAC/issues/16
      Specified by:
      getData in interface NXsubentry
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXdata for that node.

    • setData

      void setData(String name, NXdata data)
      Set a NXdata node by name:
      • The data group .. note:: Before the NIAC2016 meeting [#]_, at least one :ref:`NXdata` group was required in each :ref:`NXentry` group. At the NIAC2016 meeting, it was decided to make :ref:`NXdata` an optional group in :ref:`NXentry` groups for data files that do not use an application definition. It is recommended strongly that all NeXus data files provide a NXdata group. It is permissible 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: https://www.nexusformat.org/NIAC2016.html, https://github.com/nexusformat/NIAC/issues/16
      Specified by:
      setData in interface NXsubentry
      Parameters:
      name - the name of the node
      data - the value to set

    • getAllData

      Map<String,NXdata> getAllData()
      Get all NXdata nodes:
      • The data group .. note:: Before the NIAC2016 meeting [#]_, at least one :ref:`NXdata` group was required in each :ref:`NXentry` group. At the NIAC2016 meeting, it was decided to make :ref:`NXdata` an optional group in :ref:`NXentry` groups for data files that do not use an application definition. It is recommended strongly that all NeXus data files provide a NXdata group. It is permissible 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: https://www.nexusformat.org/NIAC2016.html, https://github.com/nexusformat/NIAC/issues/16
      Specified by:
      getAllData in interface NXsubentry
      Returns:
      a map from node names to the NXdata for that node.

    • setAllData

      void setAllData(Map<String,NXdata> data)
      Set multiple child nodes of a particular type.
      • The data group .. note:: Before the NIAC2016 meeting [#]_, at least one :ref:`NXdata` group was required in each :ref:`NXentry` group. At the NIAC2016 meeting, it was decided to make :ref:`NXdata` an optional group in :ref:`NXentry` groups for data files that do not use an application definition. It is recommended strongly that all NeXus data files provide a NXdata group. It is permissible 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: https://www.nexusformat.org/NIAC2016.html, https://github.com/nexusformat/NIAC/issues/16
      Specified by:
      setAllData in interface NXsubentry
      Parameters:
      data - the child nodes to add

    • getAttributeIdf_version

      String getAttributeIdf_version()
      ISIS Muon IDF_Version
      Specified by:
      getAttributeIdf_version in interface NXsubentry
      Returns:
      the value.

    • setAttributeIdf_version

      void setAttributeIdf_version(String idf_versionValue)
      ISIS Muon IDF_Version
      Specified by:
      setAttributeIdf_version in interface NXsubentry
      Parameters:
      idf_versionValue - the idf_versionValue

    • getTitle

      org.eclipse.january.dataset.Dataset getTitle()
      Extended title for entry
      Specified by:
      getTitle in interface NXsubentry
      Returns:
      the value.

    • setTitle

      DataNode setTitle(org.eclipse.january.dataset.IDataset titleDataset)
      Extended title for entry
      Specified by:
      setTitle in interface NXsubentry
      Parameters:
      titleDataset - the titleDataset

    • getTitleScalar

      String getTitleScalar()
      Extended title for entry
      Specified by:
      getTitleScalar in interface NXsubentry
      Returns:
      the value.

    • setTitleScalar

      DataNode setTitleScalar(String titleValue)
      Extended title for entry
      Specified by:
      setTitleScalar in interface NXsubentry
      Parameters:
      title - the title

    • getExperiment_identifier

      org.eclipse.january.dataset.Dataset getExperiment_identifier()
      Unique identifier for the experiment, defined by the facility, possibly linked to the proposals
      Specified by:
      getExperiment_identifier in interface NXsubentry
      Returns:
      the value.

    • setExperiment_identifier

      DataNode setExperiment_identifier(org.eclipse.january.dataset.IDataset experiment_identifierDataset)
      Unique identifier for the experiment, defined by the facility, possibly linked to the proposals
      Specified by:
      setExperiment_identifier in interface NXsubentry
      Parameters:
      experiment_identifierDataset - the experiment_identifierDataset

    • getExperiment_identifierScalar

      String getExperiment_identifierScalar()
      Unique identifier for the experiment, defined by the facility, possibly linked to the proposals
      Specified by:
      getExperiment_identifierScalar in interface NXsubentry
      Returns:
      the value.

    • setExperiment_identifierScalar

      DataNode setExperiment_identifierScalar(String experiment_identifierValue)
      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

      org.eclipse.january.dataset.Dataset getExperiment_description()
      Brief summary of the experiment, including key objectives.
      Specified by:
      getExperiment_description in interface NXsubentry
      Returns:
      the value.

    • setExperiment_description

      DataNode setExperiment_description(org.eclipse.january.dataset.IDataset experiment_descriptionDataset)
      Brief summary of the experiment, including key objectives.
      Specified by:
      setExperiment_description in interface NXsubentry
      Parameters:
      experiment_descriptionDataset - the experiment_descriptionDataset

    • getExperiment_descriptionScalar

      String getExperiment_descriptionScalar()
      Brief summary of the experiment, including key objectives.
      Specified by:
      getExperiment_descriptionScalar in interface NXsubentry
      Returns:
      the value.

    • setExperiment_descriptionScalar

      DataNode setExperiment_descriptionScalar(String experiment_descriptionValue)
      Brief summary of the experiment, including key objectives.
      Specified by:
      setExperiment_descriptionScalar in interface NXsubentry
      Parameters:
      experiment_description - the experiment_description

    • getExperiment_documentation

      NXnote getExperiment_documentation()
      Description of the full experiment (document in pdf, latex, ...)
      Specified by:
      getExperiment_documentation in interface NXsubentry
      Returns:
      the value.

    • setExperiment_documentation

      void setExperiment_documentation(NXnote experiment_documentationGroup)
      Description of the full experiment (document in pdf, latex, ...)
      Specified by:
      setExperiment_documentation in interface NXsubentry
      Parameters:
      experiment_documentationGroup - the experiment_documentationGroup

    • getCollection_identifier

      org.eclipse.january.dataset.Dataset getCollection_identifier()
      User or Data Acquisition defined group of NeXus files or NXentry
      Specified by:
      getCollection_identifier in interface NXsubentry
      Returns:
      the value.

    • setCollection_identifier

      DataNode setCollection_identifier(org.eclipse.january.dataset.IDataset collection_identifierDataset)
      User or Data Acquisition defined group of NeXus files or NXentry
      Specified by:
      setCollection_identifier in interface NXsubentry
      Parameters:
      collection_identifierDataset - the collection_identifierDataset

    • getCollection_identifierScalar

      String getCollection_identifierScalar()
      User or Data Acquisition defined group of NeXus files or NXentry
      Specified by:
      getCollection_identifierScalar in interface NXsubentry
      Returns:
      the value.

    • setCollection_identifierScalar

      DataNode setCollection_identifierScalar(String collection_identifierValue)
      User or Data Acquisition defined group of NeXus files or NXentry
      Specified by:
      setCollection_identifierScalar in interface NXsubentry
      Parameters:
      collection_identifier - the collection_identifier

    • getCollection_description

      org.eclipse.january.dataset.Dataset getCollection_description()
      Brief summary of the collection, including grouping criteria.
      Specified by:
      getCollection_description in interface NXsubentry
      Returns:
      the value.

    • setCollection_description

      DataNode setCollection_description(org.eclipse.january.dataset.IDataset collection_descriptionDataset)
      Brief summary of the collection, including grouping criteria.
      Specified by:
      setCollection_description in interface NXsubentry
      Parameters:
      collection_descriptionDataset - the collection_descriptionDataset

    • getCollection_descriptionScalar

      String getCollection_descriptionScalar()
      Brief summary of the collection, including grouping criteria.
      Specified by:
      getCollection_descriptionScalar in interface NXsubentry
      Returns:
      the value.

    • setCollection_descriptionScalar

      DataNode setCollection_descriptionScalar(String collection_descriptionValue)
      Brief summary of the collection, including grouping criteria.
      Specified by:
      setCollection_descriptionScalar in interface NXsubentry
      Parameters:
      collection_description - the collection_description

    • getEntry_identifier

      org.eclipse.january.dataset.Dataset getEntry_identifier()
      Unique identifier for the measurement, defined by the facility.
      Specified by:
      getEntry_identifier in interface NXsubentry
      Returns:
      the value.

    • setEntry_identifier

      DataNode setEntry_identifier(org.eclipse.january.dataset.IDataset entry_identifierDataset)
      Unique identifier for the measurement, defined by the facility.
      Specified by:
      setEntry_identifier in interface NXsubentry
      Parameters:
      entry_identifierDataset - the entry_identifierDataset

    • getEntry_identifierScalar

      String getEntry_identifierScalar()
      Unique identifier for the measurement, defined by the facility.
      Specified by:
      getEntry_identifierScalar in interface NXsubentry
      Returns:
      the value.

    • setEntry_identifierScalar

      DataNode setEntry_identifierScalar(String entry_identifierValue)
      Unique identifier for the measurement, defined by the facility.
      Specified by:
      setEntry_identifierScalar in interface NXsubentry
      Parameters:
      entry_identifier - the entry_identifier

    • getEntry_identifier_uuid

      org.eclipse.january.dataset.Dataset getEntry_identifier_uuid()
      UUID identifier for the measurement.
      Returns:
      the value.

    • setEntry_identifier_uuid

      DataNode setEntry_identifier_uuid(org.eclipse.january.dataset.IDataset entry_identifier_uuidDataset)
      UUID identifier for the measurement.
      Parameters:
      entry_identifier_uuidDataset - the entry_identifier_uuidDataset

    • getEntry_identifier_uuidScalar

      String getEntry_identifier_uuidScalar()
      UUID identifier for the measurement.
      Returns:
      the value.

    • setEntry_identifier_uuidScalar

      DataNode setEntry_identifier_uuidScalar(String entry_identifier_uuidValue)
      UUID identifier for the measurement.
      Parameters:
      entry_identifier_uuid - the entry_identifier_uuid

    • getEntry_identifier_uuidAttributeVersion

      String getEntry_identifier_uuidAttributeVersion()
      Version of UUID used
      Returns:
      the value.

    • setEntry_identifier_uuidAttributeVersion

      void setEntry_identifier_uuidAttributeVersion(String versionValue)
      Version of UUID used
      Parameters:
      versionValue - the versionValue

    • getFeatures

      org.eclipse.january.dataset.Dataset getFeatures()
      Reserved for future use by NIAC. See https://github.com/nexusformat/definitions/issues/382
      Returns:
      the value.

    • setFeatures

      DataNode setFeatures(org.eclipse.january.dataset.IDataset featuresDataset)
      Reserved for future use by NIAC. See https://github.com/nexusformat/definitions/issues/382
      Parameters:
      featuresDataset - the featuresDataset

    • getFeaturesScalar

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

    • setFeaturesScalar

      DataNode setFeaturesScalar(String featuresValue)
      Reserved for future use by NIAC. See https://github.com/nexusformat/definitions/issues/382
      Parameters:
      features - the features

    • getDefinition

      org.eclipse.january.dataset.Dataset getDefinition()
      (alternate use: see same field in :ref:`NXsubentry` for preferred) Official NeXus NXDL schema to which this entry conforms which must be the name of the NXDL file (case sensitive without the file extension) that the NXDL schema is defined in. For example the ``definition`` field for a file that conformed to the *NXarpes.nxdl.xml* definition must contain the string **NXarpes**. This field is provided so that :ref:`NXentry` can be the overlay position in a NeXus data file for an application definition and its set of groups, fields, and attributes. *It is advised* to use :ref:`NXsubentry`, instead, as the overlay position.
      Specified by:
      getDefinition in interface NXsubentry
      Returns:
      the value.

    • setDefinition

      DataNode setDefinition(org.eclipse.january.dataset.IDataset definitionDataset)
      (alternate use: see same field in :ref:`NXsubentry` for preferred) Official NeXus NXDL schema to which this entry conforms which must be the name of the NXDL file (case sensitive without the file extension) that the NXDL schema is defined in. For example the ``definition`` field for a file that conformed to the *NXarpes.nxdl.xml* definition must contain the string **NXarpes**. This field is provided so that :ref:`NXentry` can be the overlay position in a NeXus data file for an application definition and its set of groups, fields, and attributes. *It is advised* to use :ref:`NXsubentry`, instead, as the overlay position.
      Specified by:
      setDefinition in interface NXsubentry
      Parameters:
      definitionDataset - the definitionDataset

    • getDefinitionScalar

      String getDefinitionScalar()
      (alternate use: see same field in :ref:`NXsubentry` for preferred) Official NeXus NXDL schema to which this entry conforms which must be the name of the NXDL file (case sensitive without the file extension) that the NXDL schema is defined in. For example the ``definition`` field for a file that conformed to the *NXarpes.nxdl.xml* definition must contain the string **NXarpes**. This field is provided so that :ref:`NXentry` can be the overlay position in a NeXus data file for an application definition and its set of groups, fields, and attributes. *It is advised* to use :ref:`NXsubentry`, instead, as the overlay position.
      Specified by:
      getDefinitionScalar in interface NXsubentry
      Returns:
      the value.

    • setDefinitionScalar

      DataNode setDefinitionScalar(String definitionValue)
      (alternate use: see same field in :ref:`NXsubentry` for preferred) Official NeXus NXDL schema to which this entry conforms which must be the name of the NXDL file (case sensitive without the file extension) that the NXDL schema is defined in. For example the ``definition`` field for a file that conformed to the *NXarpes.nxdl.xml* definition must contain the string **NXarpes**. This field is provided so that :ref:`NXentry` can be the overlay position in a NeXus data file for an application definition and its set of groups, fields, and attributes. *It is advised* to use :ref:`NXsubentry`, instead, as the overlay position.
      Specified by:
      setDefinitionScalar in interface NXsubentry
      Parameters:
      definition - the definition

    • getDefinitionAttributeVersion

      String getDefinitionAttributeVersion()
      NXDL version number
      Specified by:
      getDefinitionAttributeVersion in interface NXsubentry
      Returns:
      the value.

    • setDefinitionAttributeVersion

      void setDefinitionAttributeVersion(String versionValue)
      NXDL version number
      Specified by:
      setDefinitionAttributeVersion in interface NXsubentry
      Parameters:
      versionValue - the versionValue

    • getDefinitionAttributeUrl

      String getDefinitionAttributeUrl()
      URL of NXDL file
      Specified by:
      getDefinitionAttributeUrl in interface NXsubentry
      Returns:
      the value.

    • setDefinitionAttributeUrl

      void setDefinitionAttributeUrl(String urlValue)
      URL of NXDL file
      Specified by:
      setDefinitionAttributeUrl in interface NXsubentry
      Parameters:
      urlValue - the urlValue

    • getDefinition_local

      @Deprecated org.eclipse.january.dataset.Dataset getDefinition_local()
      Deprecated.
      see same field in :ref:`NXsubentry` for preferred use
      Local NXDL schema extended from the entry specified in the ``definition`` field. This contains any locally-defined, additional fields in the entry.
      Specified by:
      getDefinition_local in interface NXsubentry
      Returns:
      the value.

    • setDefinition_local

      @Deprecated DataNode setDefinition_local(org.eclipse.january.dataset.IDataset definition_localDataset)
      Deprecated.
      see same field in :ref:`NXsubentry` for preferred use
      Local NXDL schema extended from the entry specified in the ``definition`` field. This contains any locally-defined, additional fields in the entry.
      Specified by:
      setDefinition_local in interface NXsubentry
      Parameters:
      definition_localDataset - the definition_localDataset

    • getDefinition_localScalar

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

    • setDefinition_localScalar

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

    • getDefinition_localAttributeVersion

      String getDefinition_localAttributeVersion()
      NXDL version number
      Specified by:
      getDefinition_localAttributeVersion in interface NXsubentry
      Returns:
      the value.

    • setDefinition_localAttributeVersion

      void setDefinition_localAttributeVersion(String versionValue)
      NXDL version number
      Specified by:
      setDefinition_localAttributeVersion in interface NXsubentry
      Parameters:
      versionValue - the versionValue

    • getDefinition_localAttributeUrl

      String getDefinition_localAttributeUrl()
      URL of NXDL file
      Specified by:
      getDefinition_localAttributeUrl in interface NXsubentry
      Returns:
      the value.

    • setDefinition_localAttributeUrl

      void setDefinition_localAttributeUrl(String urlValue)
      URL of NXDL file
      Specified by:
      setDefinition_localAttributeUrl in interface NXsubentry
      Parameters:
      urlValue - the urlValue

    • getStart_time

      org.eclipse.january.dataset.Dataset getStart_time()
      Starting time of measurement

      Type: NX_DATE_TIME

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

    • setStart_time

      DataNode setStart_time(org.eclipse.january.dataset.IDataset start_timeDataset)
      Starting time of measurement

      Type: NX_DATE_TIME

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

    • getStart_timeScalar

      Date getStart_timeScalar()
      Starting time of measurement

      Type: NX_DATE_TIME

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

    • setStart_timeScalar

      DataNode setStart_timeScalar(Date start_timeValue)
      Starting time of measurement

      Type: NX_DATE_TIME

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

    • getEnd_time

      org.eclipse.january.dataset.Dataset getEnd_time()
      Ending time of measurement

      Type: NX_DATE_TIME

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

    • setEnd_time

      DataNode setEnd_time(org.eclipse.january.dataset.IDataset end_timeDataset)
      Ending time of measurement

      Type: NX_DATE_TIME

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

    • getEnd_timeScalar

      Date getEnd_timeScalar()
      Ending time of measurement

      Type: NX_DATE_TIME

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

    • setEnd_timeScalar

      DataNode setEnd_timeScalar(Date end_timeValue)
      Ending time of measurement

      Type: NX_DATE_TIME

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

    • getDuration

      org.eclipse.january.dataset.Dataset getDuration()
      Duration of measurement

      Type: NX_INT Units: NX_TIME

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

    • setDuration

      DataNode setDuration(org.eclipse.january.dataset.IDataset durationDataset)
      Duration of measurement

      Type: NX_INT Units: NX_TIME

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

    • getDurationScalar

      Long getDurationScalar()
      Duration of measurement

      Type: NX_INT Units: NX_TIME

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

    • setDurationScalar

      DataNode setDurationScalar(Long durationValue)
      Duration of measurement

      Type: NX_INT Units: NX_TIME

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

    • getCollection_time

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

      Type: NX_FLOAT Units: NX_TIME

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

    • setCollection_time

      DataNode setCollection_time(org.eclipse.january.dataset.IDataset collection_timeDataset)
      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_timeDataset - the collection_timeDataset

    • getCollection_timeScalar

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

      Type: NX_FLOAT Units: NX_TIME

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

    • setCollection_timeScalar

      DataNode setCollection_timeScalar(Double collection_timeValue)
      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

      org.eclipse.january.dataset.Dataset getRun_cycle()
      Such as "2007-3". Some user facilities organize their beam time into run cycles.
      Specified by:
      getRun_cycle in interface NXsubentry
      Returns:
      the value.

    • setRun_cycle

      DataNode setRun_cycle(org.eclipse.january.dataset.IDataset run_cycleDataset)
      Such as "2007-3". Some user facilities organize their beam time into run cycles.
      Specified by:
      setRun_cycle in interface NXsubentry
      Parameters:
      run_cycleDataset - the run_cycleDataset

    • getRun_cycleScalar

      String getRun_cycleScalar()
      Such as "2007-3". Some user facilities organize their beam time into run cycles.
      Specified by:
      getRun_cycleScalar in interface NXsubentry
      Returns:
      the value.

    • setRun_cycleScalar

      DataNode setRun_cycleScalar(String run_cycleValue)
      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

      org.eclipse.january.dataset.Dataset getProgram_name()
      Name of program used to generate this file
      Specified by:
      getProgram_name in interface NXsubentry
      Returns:
      the value.

    • setProgram_name

      DataNode setProgram_name(org.eclipse.january.dataset.IDataset program_nameDataset)
      Name of program used to generate this file
      Specified by:
      setProgram_name in interface NXsubentry
      Parameters:
      program_nameDataset - the program_nameDataset

    • getProgram_nameScalar

      String getProgram_nameScalar()
      Name of program used to generate this file
      Specified by:
      getProgram_nameScalar in interface NXsubentry
      Returns:
      the value.

    • setProgram_nameScalar

      DataNode setProgram_nameScalar(String program_nameValue)
      Name of program used to generate this file
      Specified by:
      setProgram_nameScalar in interface NXsubentry
      Parameters:
      program_name - the program_name

    • getProgram_nameAttributeVersion

      String getProgram_nameAttributeVersion()
      Program version number
      Specified by:
      getProgram_nameAttributeVersion in interface NXsubentry
      Returns:
      the value.

    • setProgram_nameAttributeVersion

      void setProgram_nameAttributeVersion(String versionValue)
      Program version number
      Specified by:
      setProgram_nameAttributeVersion in interface NXsubentry
      Parameters:
      versionValue - the versionValue

    • getProgram_nameAttributeConfiguration

      String getProgram_nameAttributeConfiguration()
      configuration of the program
      Specified by:
      getProgram_nameAttributeConfiguration in interface NXsubentry
      Returns:
      the value.

    • setProgram_nameAttributeConfiguration

      void setProgram_nameAttributeConfiguration(String configurationValue)
      configuration of the program
      Specified by:
      setProgram_nameAttributeConfiguration in interface NXsubentry
      Parameters:
      configurationValue - the configurationValue

    • getRevision

      org.eclipse.january.dataset.Dataset getRevision()
      Revision id of the file due to re-calibration, reprocessing, new analysis, new instrument definition format, ...
      Specified by:
      getRevision in interface NXsubentry
      Returns:
      the value.

    • setRevision

      DataNode setRevision(org.eclipse.january.dataset.IDataset revisionDataset)
      Revision id of the file due to re-calibration, reprocessing, new analysis, new instrument definition format, ...
      Specified by:
      setRevision in interface NXsubentry
      Parameters:
      revisionDataset - the revisionDataset

    • getRevisionScalar

      String getRevisionScalar()
      Revision id of the file due to re-calibration, reprocessing, new analysis, new instrument definition format, ...
      Specified by:
      getRevisionScalar in interface NXsubentry
      Returns:
      the value.

    • setRevisionScalar

      DataNode setRevisionScalar(String revisionValue)
      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

      String getRevisionAttributeComment()
      Specified by:
      getRevisionAttributeComment in interface NXsubentry
      Returns:
      the value.

    • setRevisionAttributeComment

      void setRevisionAttributeComment(String commentValue)
      Specified by:
      setRevisionAttributeComment in interface NXsubentry
      Parameters:
      commentValue - the commentValue

    • getPre_sample_flightpath

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

      Type: NX_FLOAT Units: NX_LENGTH

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

    • setPre_sample_flightpath

      DataNode setPre_sample_flightpath(org.eclipse.january.dataset.IDataset pre_sample_flightpathDataset)
      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_flightpathDataset - the pre_sample_flightpathDataset

    • getPre_sample_flightpathScalar

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

      Type: NX_FLOAT Units: NX_LENGTH

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

    • setPre_sample_flightpathScalar

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

      Type: NX_FLOAT Units: NX_LENGTH

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

    • getNotes

      NXnote getNotes()
      Notes describing entry
      Specified by:
      getNotes in interface NXsubentry
      Returns:
      the value.

    • setNotes

      void setNotes(NXnote notesGroup)
      Notes describing entry
      Specified by:
      setNotes in interface NXsubentry
      Parameters:
      notesGroup - the notesGroup

    • getThumbnail

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

    • setThumbnail

      void setThumbnail(NXnote thumbnailGroup)
      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:
      thumbnailGroup - the thumbnailGroup

    • getUser

      NXuser getUser()
      Specified by:
      getUser in interface NXsubentry
      Returns:
      the value.

    • setUser

      void setUser(NXuser userGroup)
      Specified by:
      setUser in interface NXsubentry
      Parameters:
      userGroup - the userGroup

    • getUser

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

    • setUser

      void setUser(String name, NXuser user)
      Set a NXuser node by name:
      Specified by:
      setUser in interface NXsubentry
      Parameters:
      name - the name of the node
      user - the value to set

    • getAllUser

      Map<String,NXuser> getAllUser()
      Get all NXuser nodes:
      Specified by:
      getAllUser in interface NXsubentry
      Returns:
      a map from node names to the NXuser for that node.

    • setAllUser

      void setAllUser(Map<String,NXuser> user)
      Set multiple child nodes of a particular type.
      Specified by:
      setAllUser in interface NXsubentry
      Parameters:
      user - the child nodes to add

    • getSample

      NXsample getSample()
      Specified by:
      getSample in interface NXsubentry
      Returns:
      the value.

    • setSample

      void setSample(NXsample sampleGroup)
      Specified by:
      setSample in interface NXsubentry
      Parameters:
      sampleGroup - the sampleGroup

    • getSample

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

    • setSample

      void setSample(String name, NXsample sample)
      Set a NXsample node by name:
      Specified by:
      setSample in interface NXsubentry
      Parameters:
      name - the name of the node
      sample - the value to set

    • getAllSample

      Map<String,NXsample> getAllSample()
      Get all NXsample nodes:
      Specified by:
      getAllSample in interface NXsubentry
      Returns:
      a map from node names to the NXsample for that node.

    • setAllSample

      void setAllSample(Map<String,NXsample> sample)
      Set multiple child nodes of a particular type.
      Specified by:
      setAllSample in interface NXsubentry
      Parameters:
      sample - the child nodes to add

    • getInstrument

      NXinstrument getInstrument()
      Specified by:
      getInstrument in interface NXsubentry
      Returns:
      the value.

    • setInstrument

      void setInstrument(NXinstrument instrumentGroup)
      Specified by:
      setInstrument in interface NXsubentry
      Parameters:
      instrumentGroup - the instrumentGroup

    • getInstrument

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

    • setInstrument

      void setInstrument(String name, NXinstrument instrument)
      Set a NXinstrument node by name:
      Specified by:
      setInstrument in interface NXsubentry
      Parameters:
      name - the name of the node
      instrument - the value to set

    • getAllInstrument

      Map<String,NXinstrument> getAllInstrument()
      Get all NXinstrument nodes:
      Specified by:
      getAllInstrument in interface NXsubentry
      Returns:
      a map from node names to the NXinstrument for that node.

    • setAllInstrument

      void setAllInstrument(Map<String,NXinstrument> instrument)
      Set multiple child nodes of a particular type.
      Specified by:
      setAllInstrument in interface NXsubentry
      Parameters:
      instrument - the child nodes to add

    • getCollection

      NXcollection getCollection()
      Specified by:
      getCollection in interface NXsubentry
      Returns:
      the value.

    • setCollection

      void setCollection(NXcollection collectionGroup)
      Specified by:
      setCollection in interface NXsubentry
      Parameters:
      collectionGroup - the collectionGroup

    • getCollection

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

    • setCollection

      void setCollection(String name, NXcollection collection)
      Set a NXcollection node by name:
      Specified by:
      setCollection in interface NXsubentry
      Parameters:
      name - the name of the node
      collection - the value to set

    • getAllCollection

      Map<String,NXcollection> getAllCollection()
      Get all NXcollection nodes:
      Specified by:
      getAllCollection in interface NXsubentry
      Returns:
      a map from node names to the NXcollection for that node.

    • setAllCollection

      void setAllCollection(Map<String,NXcollection> collection)
      Set multiple child nodes of a particular type.
      Specified by:
      setAllCollection in interface NXsubentry
      Parameters:
      collection - the child nodes to add

    • getMonitor

      NXmonitor getMonitor()
      Specified by:
      getMonitor in interface NXsubentry
      Returns:
      the value.

    • setMonitor

      void setMonitor(NXmonitor monitorGroup)
      Specified by:
      setMonitor in interface NXsubentry
      Parameters:
      monitorGroup - the monitorGroup

    • getMonitor

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

    • setMonitor

      void setMonitor(String name, NXmonitor monitor)
      Set a NXmonitor node by name:
      Specified by:
      setMonitor in interface NXsubentry
      Parameters:
      name - the name of the node
      monitor - the value to set

    • getAllMonitor

      Map<String,NXmonitor> getAllMonitor()
      Get all NXmonitor nodes:
      Specified by:
      getAllMonitor in interface NXsubentry
      Returns:
      a map from node names to the NXmonitor for that node.

    • setAllMonitor

      void setAllMonitor(Map<String,NXmonitor> monitor)
      Set multiple child nodes of a particular type.
      Specified by:
      setAllMonitor in interface NXsubentry
      Parameters:
      monitor - the child nodes to add

    • getParameters

      NXparameters getParameters()
      Specified by:
      getParameters in interface NXsubentry
      Returns:
      the value.

    • setParameters

      void setParameters(NXparameters parametersGroup)
      Specified by:
      setParameters in interface NXsubentry
      Parameters:
      parametersGroup - the parametersGroup

    • getParameters

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

    • setParameters

      void setParameters(String name, NXparameters parameters)
      Set a NXparameters node by name:
      Specified by:
      setParameters in interface NXsubentry
      Parameters:
      name - the name of the node
      parameters - the value to set

    • getAllParameters

      Map<String,NXparameters> getAllParameters()
      Get all NXparameters nodes:
      Specified by:
      getAllParameters in interface NXsubentry
      Returns:
      a map from node names to the NXparameters for that node.

    • setAllParameters

      void setAllParameters(Map<String,NXparameters> parameters)
      Set multiple child nodes of a particular type.
      Specified by:
      setAllParameters in interface NXsubentry
      Parameters:
      parameters - the child nodes to add

    • getProcess

      NXprocess getProcess()
      Specified by:
      getProcess in interface NXsubentry
      Returns:
      the value.

    • setProcess

      void setProcess(NXprocess processGroup)
      Specified by:
      setProcess in interface NXsubentry
      Parameters:
      processGroup - the processGroup

    • getProcess

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

    • setProcess

      void setProcess(String name, NXprocess process)
      Set a NXprocess node by name:
      Specified by:
      setProcess in interface NXsubentry
      Parameters:
      name - the name of the node
      process - the value to set

    • getAllProcess

      Map<String,NXprocess> getAllProcess()
      Get all NXprocess nodes:
      Specified by:
      getAllProcess in interface NXsubentry
      Returns:
      a map from node names to the NXprocess for that node.

    • setAllProcess

      void setAllProcess(Map<String,NXprocess> process)
      Set multiple child nodes of a particular type.
      Specified by:
      setAllProcess in interface NXsubentry
      Parameters:
      process - the child nodes to add

    • getSubentry

      NXsubentry getSubentry()
      Returns:
      the value.

    • setSubentry

      void setSubentry(NXsubentry subentryGroup)
      Parameters:
      subentryGroup - the subentryGroup

    • getSubentry

      NXsubentry getSubentry(String name)
      Get a NXsubentry node by name:
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXsubentry for that node.

    • setSubentry

      void setSubentry(String name, NXsubentry subentry)
      Set a NXsubentry node by name:
      Parameters:
      name - the name of the node
      subentry - the value to set

    • getAllSubentry

      Map<String,NXsubentry> getAllSubentry()
      Get all NXsubentry nodes:
      Returns:
      a map from node names to the NXsubentry for that node.

    • setAllSubentry

      void setAllSubentry(Map<String,NXsubentry> subentry)
      Set multiple child nodes of a particular type.
      Parameters:
      subentry - the child nodes to add