:py:mod:`tree_model`
====================

.. py:module:: tree_model


Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   tree_model.DatasetTreeNode
   tree_model.DatasetTreeModel




Attributes
~~~~~~~~~~

.. autoapisummary::

   tree_model.logger


.. py:data:: logger
   :value: "'tree_model'"

   

.. py:class:: DatasetTreeNode(name, dataobj, datatype, checked=False)


   Bases: :py:obj:`object`

   Contains the files with their respective particles. Also seems to house the actual data objects.

   .. py:attribute:: _data

      

   .. py:attribute:: _columncount

      

   .. py:attribute:: _children
      :value: '[]'

      

   .. py:attribute:: _parent
      :value: 'None'

      

   .. py:attribute:: _row
      :value: '0'

      

   .. py:attribute:: datatype

      

   .. py:attribute:: dataobj

      

   .. py:method:: checked()

      Appears to be used internally.

      :rtype: Returns check status.


   .. py:method:: setChecked(checked=True)


   .. py:method:: data(in_column)

      Return the data from a provided index

      :param in_column:
      :type in_column: Index of column

      :rtype: data


   .. py:method:: columnCount()

      Returns the number of columns within the node.

      :rtype: int


   .. py:method:: childCount()

      Returns the number of children within the node.

      :rtype: int


   .. py:method:: child(in_row)

      Returns the child of the provided row index.

      :param in_row:
      :type in_row: Row index

      :rtype: child


   .. py:method:: parent()

      Returns the parent of this node.

      :rtype: parent


   .. py:method:: row()

      Returns the row of this node.

      :rtype: row


   .. py:method:: addChild(in_child)

      Add a child at the provided index.

      :param in_child:



.. py:class:: DatasetTreeModel


   Bases: :py:obj:`PyQt5.QtCore.QAbstractItemModel`

   An item model for the dataset tree view.

   .. py:attribute:: _root

      

   .. py:attribute:: none

      

   .. py:attribute:: r

      

   .. py:attribute:: l

      

   .. py:attribute:: a

      

   .. py:attribute:: e

      

   .. py:attribute:: rl

      

   .. py:attribute:: rg

      

   .. py:attribute:: ra

      

   .. py:attribute:: re

      

   .. py:attribute:: la

      

   .. py:attribute:: le

      

   .. py:attribute:: ae

      

   .. py:attribute:: rlg

      

   .. py:attribute:: rla

      

   .. py:attribute:: rle

      

   .. py:attribute:: rga

      

   .. py:attribute:: rge

      

   .. py:attribute:: rae

      

   .. py:attribute:: lae

      

   .. py:attribute:: rlga

      

   .. py:attribute:: rlge

      

   .. py:attribute:: rlae

      

   .. py:attribute:: rgae

      

   .. py:attribute:: rlgae

      

   .. py:method:: flags(index)


   .. py:method:: rowCount(in_index)

      TODO: Docstring

      :param in_index:


   .. py:method:: addChild(in_node, in_parent=None)

      TODO: Docstring

      :param in_node:
      :param in_parent:
      :param progress_sig:


   .. py:method:: index(in_row, in_column, in_parent=None)

      TODO: Docstring

      :param in_row:
      :param in_column:
      :param in_parent:


   .. py:method:: parent(in_index)

      TODO: Docstring

      :param in_index:


   .. py:method:: columnCount(in_index)

      TODO: Docstring

      :param in_index:


   .. py:method:: get_particle(ind) -> smsh5.Particle

      Returns the smsh5.Particle object of the ind'th tree particle.

      :param ind: The index of the particle.
      :type ind: int

      :rtype: smsh5.Particle


   .. py:method:: data(in_index, role)

      TODO: Docstring

      :param in_index:
      :param role:


   .. py:method:: setData(index, value, role=Qt.EditRole)