.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXtextlog.nxdl.xml -- DO NOT EDIT .. index:: ! NXtextlog (base class) ! textlog (base class) see: textlog (base class); NXtextlog .. _NXtextlog: ========= NXtextlog ========= **Status**: *base class* (contribution), extends :ref:`NXobject` **Description**: .. collapse:: Textual Information recorded as a function of time. ... Textual Information recorded as a function of time. This is very similar to an :ref:`NXlog` but aimed at character rather than numeric data. It is to cover use cases when character data is to be recorded but using a large number of e.g. :ref:`NXnote` classes is undesirable. It would be used for cases like: - Status or error messages from hardware or software - Character based metadata e.g. labels that may vary during data collection Data is stored with times at which they were measured as elapsed time since a starting time recorded in ISO8601 format. The time units are specified in the units attribute. An optional scaling attribute can be used to accommodate non standard clocks. In order to make random access to timestamped data faster there is an optional array pair of ``cue_timestamp_zero`` and ``cue_index``. The ``cue_timestamp_zero`` will contain coarser timestamps than in the time array, say every five minutes. The ``cue_index`` will then contain the index into the time,value pair of arrays for that coarser ``cue_timestamp_zero``. **Symbols**: Symbols used below to illustrate the rank and sizes of datasets **n**: Number of logged values **Groups cited**: none **Structure**: .. _/NXtextlog/time-field: .. index:: time (field) **time**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n]) {units=\ :ref:`NX_TIME `} .. collapse:: Time of logged entry. The times are relative to the "start" attribute ... Time of logged entry. The times are relative to the "start" attribute and in the units specified in the "units" attribute. Please note that absolute timestamps under unix are relative to ``1970-01-01T00:00:00.0Z``. The "scaling_factor" attribute, when present, has to be applied to the time values in order to arrive at the units specified in the units attribute. The "scaling_factor" allows for arbitrary time units such as ticks of some hardware clock. .. _/NXtextlog/time@start-attribute: .. index:: start (field attribute) **@start**: (optional) :ref:`NX_DATE_TIME ` .. _/NXtextlog/time@scaling_factor-attribute: .. index:: scaling_factor (field attribute) **@scaling_factor**: (optional) :ref:`NX_NUMBER ` .. _/NXtextlog/value-field: .. index:: value (field) **value**: (optional) :ref:`NX_CHAR ` (Rank: 1, Dimensions: [n]) .. collapse:: String array of logged values, same length and dimensionality ... String array of logged values, same length and dimensionality as ``time`` array field. If you have stored multiple items here and wish each to be interpreted separately by the reader then you can specify a "separator" attribute to indicate how to split them up. However you should consider whether it is clearer to write multiple ``value`` elements with the same ``time``, or separate NXtextlog instances, instead. .. _/NXtextlog/value@separator-attribute: .. index:: separator (field attribute) **@separator**: (optional) :ref:`NX_CHAR ` .. collapse:: Optional character string that can be used to specify how to split a ... Optional character string that can be used to specify how to split a text ``value`` into multiple items. .. _/NXtextlog/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` Description of logged value .. _/NXtextlog/duration-field: .. index:: duration (field) **duration**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} Total time log was taken .. _/NXtextlog/cue_timestamp_zero-field: .. index:: cue_timestamp_zero (field) **cue_timestamp_zero**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_TIME `} .. collapse:: Timestamps matching the corresponding cue_index into the ... Timestamps matching the corresponding cue_index into the time, value pair. .. _/NXtextlog/cue_timestamp_zero@start-attribute: .. index:: start (field attribute) **@start**: (optional) :ref:`NX_DATE_TIME ` If missing start is assumed to be the same as for "time". .. _/NXtextlog/cue_timestamp_zero@scaling_factor-attribute: .. index:: scaling_factor (field attribute) **@scaling_factor**: (optional) :ref:`NX_NUMBER ` If missing start is assumed to be the same as for "time". .. _/NXtextlog/cue_index-field: .. index:: cue_index (field) **cue_index**: (optional) :ref:`NX_INT ` .. collapse:: Index into the time, value pair matching the corresponding ... Index into the time, value pair matching the corresponding cue_timestamp_zero. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXtextlog/cue_index-field ` * :ref:`/NXtextlog/cue_timestamp_zero-field ` * :ref:`/NXtextlog/cue_timestamp_zero@scaling_factor-attribute ` * :ref:`/NXtextlog/cue_timestamp_zero@start-attribute ` * :ref:`/NXtextlog/description-field ` * :ref:`/NXtextlog/duration-field ` * :ref:`/NXtextlog/time-field ` * :ref:`/NXtextlog/time@scaling_factor-attribute ` * :ref:`/NXtextlog/time@start-attribute ` * :ref:`/NXtextlog/value-field ` * :ref:`/NXtextlog/value@separator-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXtextlog.nxdl.xml