=======
Classes
=======
Get the classes in the DEXPI Information Model.

Each row of the query result gives information about one class.

Variables
=========

cls
    The class.

package
    The package that contains the class. The package corresponds
    to a chapter in the DEXPI P&ID Specification 1.2.

is_abstract
    A boolean that indicates if the class is abstract. An
    abstract class must not be instantiated directly.

    .. note:: If a class is abstract, this does not mean that a certain
       XML element is forbidden in a DEXPI-compliant Proteus XML
       file.

       For example, the DEXPI class ``Equipment`` is abstract. In
       Proteus XML, any instance of a concrete subclass of
       ``Equipment`` will be represented by an ``<Equipment>`` XML
       element. The subclass will be given by an appropriate RDL
       reference. However, as the DEXPI class is abstract, this
       RDL reference should be more specific than that of
       Equipment.

description
    Optional. A description of the class.

    .. note:: Descriptions may contain markup that is used to build the
       official PDF version of the DEXPI Specification. In the
       cached HTML, CSV, and Excel results below, this markup has
       been removed for better readability. For example, a
       description such as *An object that can act as the
       \\labeledref[declaration:SignalConveyingFunction:]{Source}
       of a \\labeledref[class:]{SignalConveyingFunction}* will be
       shown as *An object that can act as the Source of a
       SignalConveyingFunction*.

proteus_rdl
    Optional. The RDL reference associated with the class in a
    DEXPI-compliant Proteus file.

SPARQL Query
============


.. code-block:: sparql

    PREFIX meta: <http://sandbox.dexpi.org/meta/>

    SELECT ?cls ?package ?is_abstract ?description ?proteus_rdl
    WHERE
    {
        ?class_obj a meta:ModelClass;
            meta:simpleLabel ?cls.

        ?scope a meta:Scope;
            meta:contains ?class_obj;
            meta:simpleLabel ?package.

        BIND(EXISTS {?class_obj a meta:AbstractClass} as ?is_abstract)

        OPTIONAL
        {
            ?class_obj meta:description ?description.
        }

        OPTIONAL
        {
            ?class_obj meta:rdl ?proteus_rdl.
        }
    }
    ORDER BY ?cls

Partial SPARQL Results
======================

The full query result contains 164 rows. The first rows are as follows:

+-------------------+-----------------+-------------+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| cls               | package         | is_abstract | description                                                                                                                      | proteus_rdl                                    |
+===================+=================+=============+==================================================================================================================================+================================================+
| ActuatingFunction | Instrumentation | false       | A function for acting control structures relating to the process.                                                                | http://sandbox.dexpi.org/rdl/ActuatingFunction |
+-------------------+-----------------+-------------+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| ActuatingSystem   | Instrumentation | false       | An assembly of artefacts that is designed to fulfill an ActuatingFunction.                                                       | http://sandbox.dexpi.org/rdl/ActuatingSystem   |
+-------------------+-----------------+-------------+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| Agitator          | Equipment       | false       | A dynamic mixer that stir or shake fluids by reaction force from moving vanes (from http://data.posccaesar.org/rdl/RDS16045622). | http://data.posccaesar.org/rdl/RDS16045622     |
+-------------------+-----------------+-------------+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| AgitatorRotor     | Equipment       | false       | An agitator rotor.                                                                                                               | http://sandbox.dexpi.org/rdl/AgitatorRotor     |
+-------------------+-----------------+-------------+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| AirCoolingSystem  | Equipment       | false       | A cooling system which uses air as the cooling medium (from http://data.posccaesar.org/rdl/RDS277379).                           | http://data.posccaesar.org/rdl/RDS277379       |
+-------------------+-----------------+-------------+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+
| ...               | ...             | ...         | ...                                                                                                                              | ...                                            |
+-------------------+-----------------+-------------+----------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------+

Full SPARQL Results
===================

Cached
------

.. note:: The cached results below are guaranteed to correspond to DEXPI P&ID Specification 1.2.

Cached results:



* :doc:`HTML table <classes_result>`

* :download:`CSV <classes_result.txt>` (encoding: UTF-8,
  column separator: tabulator (Unicode: ``CHARACTER TABULATION``, i.e.
  ``\u0009``), row separator: line feed (Unicode: ``LINE FEED (LF)``,
  i.e. ``\u000a``) 

* :download:`Office Open XML Spreadsheet  <classes_result.xlsx>`
  (LibreOffice, OpenOffice, Excel, etc.)

* :download:`XML <classes_result.xml>` (see
  `SPARQL Query Results XML Format
  <https://www.w3.org/TR/2013/REC-rdf-sparql-XMLres-20130321>`_)


Online
======

.. note:: Online results can change! There is no guarantee that these results correspond to DEXPI P&ID Specification 1.2.

Get results online from DEXPI SPARQL server at http://endpoint.dexpi.org:

* `plain text table <http://endpoint.dexpi.org/information_model/query?output=text&query=PREFIX+meta%3A+%3Chttp%3A%2F%2Fsandbox.dexpi.org%2Fmeta%2F%3E%0A%0ASELECT+%3Fcls+%3Fpackage+%3Fis_abstract+%3Fdescription+%3Fproteus_rdl%0AWHERE%0A%7B%0A++++%3Fclass_obj+a+meta%3AModelClass%3B%0A++++++++meta%3AsimpleLabel+%3Fcls.%0A%0A++++%3Fscope+a+meta%3AScope%3B%0A++++++++meta%3Acontains+%3Fclass_obj%3B%0A++++++++meta%3AsimpleLabel+%3Fpackage.%0A%0A++++BIND%28EXISTS+%7B%3Fclass_obj+a+meta%3AAbstractClass%7D+as+%3Fis_abstract%29%0A%0A++++OPTIONAL%0A++++%7B%0A++++++++%3Fclass_obj+meta%3Adescription+%3Fdescription.%0A++++%7D%0A%0A++++OPTIONAL%0A++++%7B%0A++++++++%3Fclass_obj+meta%3Ardl+%3Fproteus_rdl.%0A++++%7D%0A%7D%0AORDER+BY+%3Fcls>`__

* `HTML table <http://endpoint.dexpi.org/information_model/query?output=xml&stylesheet=%2Fxml-to-html-plain.xsl&query=PREFIX+meta%3A+%3Chttp%3A%2F%2Fsandbox.dexpi.org%2Fmeta%2F%3E%0A%0ASELECT+%3Fcls+%3Fpackage+%3Fis_abstract+%3Fdescription+%3Fproteus_rdl%0AWHERE%0A%7B%0A++++%3Fclass_obj+a+meta%3AModelClass%3B%0A++++++++meta%3AsimpleLabel+%3Fcls.%0A%0A++++%3Fscope+a+meta%3AScope%3B%0A++++++++meta%3Acontains+%3Fclass_obj%3B%0A++++++++meta%3AsimpleLabel+%3Fpackage.%0A%0A++++BIND%28EXISTS+%7B%3Fclass_obj+a+meta%3AAbstractClass%7D+as+%3Fis_abstract%29%0A%0A++++OPTIONAL%0A++++%7B%0A++++++++%3Fclass_obj+meta%3Adescription+%3Fdescription.%0A++++%7D%0A%0A++++OPTIONAL%0A++++%7B%0A++++++++%3Fclass_obj+meta%3Ardl+%3Fproteus_rdl.%0A++++%7D%0A%7D%0AORDER+BY+%3Fcls>`__

* `XML <http://endpoint.dexpi.org/information_model/query?output=xml&query=PREFIX+meta%3A+%3Chttp%3A%2F%2Fsandbox.dexpi.org%2Fmeta%2F%3E%0A%0ASELECT+%3Fcls+%3Fpackage+%3Fis_abstract+%3Fdescription+%3Fproteus_rdl%0AWHERE%0A%7B%0A++++%3Fclass_obj+a+meta%3AModelClass%3B%0A++++++++meta%3AsimpleLabel+%3Fcls.%0A%0A++++%3Fscope+a+meta%3AScope%3B%0A++++++++meta%3Acontains+%3Fclass_obj%3B%0A++++++++meta%3AsimpleLabel+%3Fpackage.%0A%0A++++BIND%28EXISTS+%7B%3Fclass_obj+a+meta%3AAbstractClass%7D+as+%3Fis_abstract%29%0A%0A++++OPTIONAL%0A++++%7B%0A++++++++%3Fclass_obj+meta%3Adescription+%3Fdescription.%0A++++%7D%0A%0A++++OPTIONAL%0A++++%7B%0A++++++++%3Fclass_obj+meta%3Ardl+%3Fproteus_rdl.%0A++++%7D%0A%7D%0AORDER+BY+%3Fcls>`__ (see `SPARQL Query Results XML Format <https://www.w3.org/TR/2013/REC-rdf-sparql-XMLres-20130321>`__)