:py:mod:`raesl.compile.ast.relations`
=====================================

.. py:module:: raesl.compile.ast.relations

.. autoapi-nested-parse::

   Relation definition and instantiation.



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

Classes
~~~~~~~

.. autoapisummary::

   raesl.compile.ast.relations.RelationDefParameter
   raesl.compile.ast.relations.RelationDefinition




Attributes
~~~~~~~~~~

.. autoapisummary::

   raesl.compile.ast.relations.INPUT
   raesl.compile.ast.relations.OUTPUT
   raesl.compile.ast.relations.INPOUT


.. py:data:: INPUT
   :value: 'input'

   

.. py:data:: OUTPUT
   :value: 'output'

   

.. py:data:: INPOUT
   :value: 'inp_out'

   

.. py:class:: RelationDefParameter(name: raesl.compile.scanner.Token, type_name: raesl.compile.scanner.Token, direction: str, multi: bool)


   Parameter of a relation definition.

   :param name: Name of the parameter.
   :param type_name: Name of the type of the parameter.
   :param direction: Direction of the parameter.
   :param multi: If set, parameter may be specified more than once.

   .. attribute:: type

      Actual type of the parameter.


.. py:class:: RelationDefinition(name: raesl.compile.scanner.Token)


   Bases: :py:obj:`raesl.compile.ast.comment_storage.DefaultDocStore`

   Relation definition.

   :param name: Name of the relation definition.

   .. attribute:: params

      Parameters of the definition.