.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXuser.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXuser (base class)
    ! user (base class)
    see: user (base class); NXuser

.. _NXuser:

======
NXuser
======

..
    Contributors List

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28

    .. |contrib_name| replace:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2020-10-20

    .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Contact information for a user. ...

      Contact information for a user.

      The format allows more 
      than one user with the same affiliation and contact information, 
      but a second :ref:`NXuser` group should be used if they have different 
      affiliations, etc.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXuser@default-attribute:

  .. index:: default (file attribute)

  **@default**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: Declares which child group contains a path leading  ...

        .. index:: plotting

        Declares which child group contains a path leading 
        to a :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.
        See https://www.nexusformat.org/2014_How_to_find_default_data.html
        for a summary of the discussion.

  .. _/NXuser/name-field:

  .. index:: name (field)

  **name**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    Name of user responsible for this entry

  .. _/NXuser/role-field:

  .. index:: role (field)

  **role**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: Role of user responsible for this entry. ...

        Role of user responsible for this entry.
        Suggested roles are "local_contact", 
        "principal_investigator", and "proposer"

  .. _/NXuser/affiliation-field:

  .. index:: affiliation (field)

  **affiliation**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    Affiliation of user

  .. _/NXuser/address-field:

  .. index:: address (field)

  **address**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    Address of user

  .. _/NXuser/telephone_number-field:

  .. index:: telephone_number (field)

  **telephone_number**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    Telephone number of user

  .. _/NXuser/fax_number-field:

  .. index:: fax_number (field)

  **fax_number**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    Fax number of user

  .. _/NXuser/email-field:

  .. index:: email (field)

  **email**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    Email of user

  .. _/NXuser/facility_user_id-field:

  .. index:: facility_user_id (field)

  **facility_user_id**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: facility based unique identifier for this person  ...

        facility based unique identifier for this person 
        e.g. their identification code on the facility 
        address/contact database

  .. _/NXuser/ORCID-field:

  .. index:: ORCID (field)

  **ORCID**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: an author code, Open Researcher and Contributor ID, ...

        an author code, Open Researcher and Contributor ID,
        defined by https://orcid.org and expressed as a URI


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXuser/address-field </NXuser/address-field>`
* :ref:`/NXuser/affiliation-field </NXuser/affiliation-field>`
* :ref:`/NXuser/email-field </NXuser/email-field>`
* :ref:`/NXuser/facility_user_id-field </NXuser/facility_user_id-field>`
* :ref:`/NXuser/fax_number-field </NXuser/fax_number-field>`
* :ref:`/NXuser/name-field </NXuser/name-field>`
* :ref:`/NXuser/ORCID-field </NXuser/ORCID-field>`
* :ref:`/NXuser/role-field </NXuser/role-field>`
* :ref:`/NXuser/telephone_number-field </NXuser/telephone_number-field>`
* :ref:`/NXuser@default-attribute </NXuser@default-attribute>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/base_classes/NXuser.nxdl.xml