API Reference
*************

Here are the classes and methods that you can call from your python plugins.


Plugin infrastructure
=====================


Plugin API
----------

.. autoclass:: cast.Plugin
   :members: 

.. autoclass:: cast.Extension
   :members: 


Analyzer level
==============

cast.analyzers package, to be used at analysis level only.

Analysis options API
--------------------

.. autoclass:: cast.analysers.ExecutionUnit
   :members: 

.. autoclass:: cast.analysers.AnalysisUnit
   :members: 

Objects API
-----------

Objects produced by the analyzer :

.. autoclass:: cast.analysers.Object
   :members: 

Objects gathered from other analysis due to dependency configuration :

.. autoclass:: cast.analysers.ExternalObject
   :members: 

.. autoclass:: cast.analysers.Bookmark
   :members: 

File
++++

.. autoclass:: cast.analysers.File
   :members: 

Classes and methods
+++++++++++++++++++

.. autoclass:: cast.analysers.Type
   :members: 

.. autoclass:: cast.analysers.Member
   :members: 

.. autoclass:: cast.analysers.Method
   :members: 

Programming type representation
+++++++++++++++++++++++++++++++

.. autoclass:: cast.analysers.TypeBase
   :members: 

.. autoclass:: cast.analysers.GenericType
   :members: 

.. autoclass:: cast.analysers.GenericTypeInstantiation
   :members: 

.. autoclass:: cast.analysers.PrimitiveType
   :members: 

.. autoclass:: cast.analysers.Array
   :members: 

.. autoclass:: cast.analysers.Pointer
   :members: 

.. autoclass:: cast.analysers.Reference
   :members: 

Link and object creation
------------------------

.. autoclass:: cast.analysers.CustomObject
   :members: 

.. autofunction:: cast.analysers.create_link

.. autoclass:: cast.analysers.Link
   :members: 

Log API
-------
   
.. automodule:: cast.analysers.log
   :members: 

External link API
-----------------

.. automodule:: cast.analysers.external_link
   :members: 

Platform utility functions
--------------------------

.. autofunction:: cast.analysers.get_temporary_directory

.. autofunction:: cast.analysers.get_intermediate_path

.. autofunction:: cast.analysers.get_cast_version

   
Filtering
---------

.. automodule:: cast.analysers.filter
   :members: 

Analysis level tests
--------------------
   
.. automodule:: cast.analysers.test
   :members: 

Application level
=================

cast.applicatin package, to be used at application level only.


Knowledge base API
------------------

.. autoclass:: cast.application.Application
   :members: 

Object query API
----------------

To write queries on objects.

.. autoclass:: cast.application.ObjectQuery
   :members: 


Objects API
-----------

Objects present in the knowledge base

.. autoclass:: cast.application.Object
   :members: 

File
++++

.. autoclass:: cast.application.File
   :members: 

Project
+++++++

Those represent result projects (vcproj, jar, dll, .project, pom.xml, ...).

.. autoclass:: cast.application.Project
   :members: 

Database
++++++++

Objects representing analysed databases are represented by the following class :


.. autoclass:: cast.application.Database
   :members: 


They be retrieved using :

.. automethod:: cast.application.Application.get_databases


Schema
++++++

.. autoclass:: cast.application.DatabaseOwner
   :members: 

Bookmark
++++++++

.. autoclass:: cast.application.Bookmark
   :members: 

Links
+++++

.. autoclass:: cast.application.EnlightenLink
   :members: 

.. autoclass:: cast.application.LinkQuery
   :members: 

.. autoclass:: cast.application.LinkType
   :members: 

Creating links
++++++++++++++

.. autofunction:: cast.application.create_link


Reference Finder
++++++++++++++++

.. autoclass:: cast.application.ReferenceFinder
   :members: