Interface NXhistory

All Superinterfaces:
GroupNode, Iterable<NodeLink>, Node, NXobject

public interface NXhistory extends NXobject
A set of activities that occurred to a physical entity prior/during experiment. Ideally, a full report of the previous operations (or links to a chain of operations). Alternatively, notes allow for additional descriptors in any format.
  • Field Details

  • Method Details

    • getActivity

      NXactivity getActivity()
      Any activity that was performed on the physical entity prior or during the experiment.
      Returns:
      the value.
    • setActivity

      void setActivity(NXactivity activityGroup)
      Any activity that was performed on the physical entity prior or during the experiment.
      Parameters:
      activityGroup - the activityGroup
    • getActivity

      NXactivity getActivity(String name)
      Get a NXactivity node by name:
      • Any activity that was performed on the physical entity prior or during the experiment.
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXactivity for that node.
    • setActivity

      void setActivity(String name, NXactivity activity)
      Set a NXactivity node by name:
      • Any activity that was performed on the physical entity prior or during the experiment.
      Parameters:
      name - the name of the node
      activity - the value to set
    • getAllActivity

      Map<String,NXactivity> getAllActivity()
      Get all NXactivity nodes:
      • Any activity that was performed on the physical entity prior or during the experiment.
      Returns:
      a map from node names to the NXactivity for that node.
    • setAllActivity

      void setAllActivity(Map<String,NXactivity> activity)
      Set multiple child nodes of a particular type.
      • Any activity that was performed on the physical entity prior or during the experiment.
      Parameters:
      activity - the child nodes to add
    • getIdentifiername

      org.eclipse.january.dataset.Dataset getIdentifiername()
      An ID or reference to the location or a unique (globally persistent) identifier of e.g. another file which gives as many as possible details of the history event.
      Returns:
      the value.
    • setIdentifiername

      DataNode setIdentifiername(org.eclipse.january.dataset.IDataset identifiernameDataset)
      An ID or reference to the location or a unique (globally persistent) identifier of e.g. another file which gives as many as possible details of the history event.
      Parameters:
      identifiernameDataset - the identifiernameDataset
    • getIdentifiernameScalar

      String getIdentifiernameScalar()
      An ID or reference to the location or a unique (globally persistent) identifier of e.g. another file which gives as many as possible details of the history event.
      Returns:
      the value.
    • setIdentifiernameScalar

      DataNode setIdentifiernameScalar(String identifiernameValue)
      An ID or reference to the location or a unique (globally persistent) identifier of e.g. another file which gives as many as possible details of the history event.
      Parameters:
      identifiername - the identifiername
    • getNote

      NXnote getNote()
      A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.
      Returns:
      the value.
    • setNote

      void setNote(NXnote noteGroup)
      A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.
      Parameters:
      noteGroup - the noteGroup
    • getNote

      NXnote getNote(String name)
      Get a NXnote node by name:
      • A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.
      Parameters:
      name - the name of the node.
      Returns:
      a map from node names to the NXnote for that node.
    • setNote

      void setNote(String name, NXnote note)
      Set a NXnote node by name:
      • A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.
      Parameters:
      name - the name of the node
      note - the value to set
    • getAllNote

      Map<String,NXnote> getAllNote()
      Get all NXnote nodes:
      • A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.
      Returns:
      a map from node names to the NXnote for that node.
    • setAllNote

      void setAllNote(Map<String,NXnote> note)
      Set multiple child nodes of a particular type.
      • A descriptor to keep track of the treatment of the physical entity before or during the experiment (NXnote allows to add pictures, audio, movies). Alternatively, a reference to the location or a unique identifier or other metadata file. In the case these are not available, free-text description. This should only be used in case that there is no rigorous description using the base classes above. This group can also be used to pull in any activities that are not well described by an existing base class definition. Any number of instances of NXnote are allowed for describing extra details of this activity.
      Parameters:
      note - the child nodes to add