==============================
Reference documentation
==============================

.. currentmodule:: pyxnat.xobject


The `Interface` class
~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pyxnat.xobject.Interface
    :members:
    :inherited-members:

The `ResourceObject` class
~~~~~~~~~~~~~~~~~~~~~~~~~~

All REST resources objects are derived from ResourceObject which contains
the common mechanisms to read and write on the server.

.. autoclass:: pyxnat.xobject.ResourceObject
    :members:

The `Project` class
~~~~~~~~~~~~~~~~~~~

.. autoclass:: pyxnat.xobject.Project
    :members:

The `Subject` class
~~~~~~~~~~~~~~~~~~~

.. autoclass:: pyxnat.xobject.Subject
    :members:

The `Experiment` class
~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pyxnat.xobject.Experiment
    :members:

The `Scan` class
~~~~~~~~~~~~~~~~

.. autoclass:: pyxnat.xobject.Scan
    :members:

The `Resource` class
~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pyxnat.xobject.Resource
    :members:

The `File` class
~~~~~~~~~~~~~~~~

.. autoclass:: pyxnat.xobject.File
    :members:

The `CacheManager` class
~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pyxnat.xobject.CacheManager
    :members: __init__, status, checkout, update, clear

The `SearchManager` class
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pyxnat.xobject.SearchManager
    :members: __call__, types, type_fields, saved, get, delete


The `Search` class
~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: pyxnat.xobject.Search
    :members:


