==========
``origen``
==========

.. automodule:: origen

   .. contents::
      :local:


Submodules
==========

.. toctree::

   origen.application
   origen.attributes
   origen.blocks
   origen.boot
   origen.compiler
   origen.controller
   origen.errors
   origen.helpers
   origen.interface
   origen.pins
   origen.producer
   origen.services
   origen.sub_blocks
   origen.target
   origen.tester
   origen.timesets
   origen.translator
   origen.translators
   origen.web

.. currentmodule:: origen


Functions
=========

- :py:func:`current_user`:
  Undocumented.

- :py:func:`flow_ast`:
  Returns a serialized representation of the AST for the current test program flow 

- :py:func:`has_plugin`:
  Returns true if an Origen plugin matching the given name is found in the current environment

- :py:func:`load_file`:
  Undocumented.

- :py:func:`plugin`:
  Returns an :class:`Origen application <origen.application.Application>` instance representing

- :py:func:`reg_description_parsing`:
  Undocumented.

- :py:func:`set_mode`:
  Sets the current mode 

- :py:func:`standard_context`:
  Returns the context (locals) that are available by default within files

- :py:func:`test_ast`:
  Returns a serialized representation of the AST for the current pattern


.. autofunction:: current_user

.. autofunction:: flow_ast

.. autofunction:: has_plugin

.. autofunction:: load_file

.. autofunction:: plugin

.. autofunction:: reg_description_parsing

.. autofunction:: set_mode

.. autofunction:: standard_context

.. autofunction:: test_ast


Variables
=========

- :py:data:`config`
- :py:data:`status`
- :py:data:`root`
- :py:data:`version`
- :py:data:`running_on_windows`
- :py:data:`running_on_linux`
- :py:data:`frontend_root`
- :py:data:`app`
- :py:data:`dut`
- :py:data:`tester`
- :py:data:`producer`
- :py:data:`users`
- :py:data:`mailer`
- :py:data:`ldaps`
- :py:data:`logger`

.. autodata:: config
   :annotation:

.. autodata:: status
   :annotation:

.. autodata:: root
   :annotation:

.. autodata:: version
   :annotation:

.. autodata:: running_on_windows
   :annotation:

.. autodata:: running_on_linux
   :annotation:

.. autodata:: frontend_root
   :annotation:

.. autodata:: app
   :annotation:

.. autodata:: dut
   :annotation:

.. autodata:: tester
   :annotation:
   :noindex:

.. autodata:: producer
   :annotation:
   :noindex:

.. autodata:: users
   :annotation:

.. autodata:: mailer
   :annotation:

.. autodata:: ldaps
   :annotation:

.. autodata:: logger
   :annotation: