Commit 3c4aec84 authored by yoogx's avatar yoogx
Browse files

* Update documentation

parent 980cfc98
...@@ -4,6 +4,8 @@ ...@@ -4,6 +4,8 @@
################################################################################ ################################################################################
import libocarina_python; # Ocarina bindings import libocarina_python; # Ocarina bindings
class Enum(tuple): __getattr__ = tuple.index
################################################################################ ################################################################################
def version (): def version ():
'''Print Ocarina version''' '''Print Ocarina version'''
...@@ -16,7 +18,16 @@ def status (): ...@@ -16,7 +18,16 @@ def status ():
################################################################################ ################################################################################
def load (filename): def load (filename):
'''Load a file''' '''Load a file
:param filename: name of the file to be loaded, following Ocarina search path
:type filename: string
E.g. to load "foo.aadl":
>>> load("foo.aadl");
'''
libocarina_python.load (filename); libocarina_python.load (filename);
################################################################################ ################################################################################
...@@ -30,22 +41,19 @@ def instantiate (root_system): ...@@ -30,22 +41,19 @@ def instantiate (root_system):
libocarina_python.instantiate (root_system); libocarina_python.instantiate (root_system);
################################################################################ ################################################################################
Backends = Enum ([ "polyorb_hi_ada", "polyorb_hi_c"]);
'''Supported backends'''
def generate (generator): def generate (generator):
'''Generate code''' '''Generate code
libocarina_python.generate (generator);
################################################################################ :param generator: one supported backends, from :data:`Backends`
def main ():
'''Test function''' For instance, to use the PolyORB-HI/Ada backend, you may use the following
load("rma.aadl"); # load a file
load("deployment.aadl"); # load a file
analyze(); # analyze models
instantiate("rma.erc32"); # instantiate
generate("polyorb_hi_ada"); # generate code
if __name__ == "__main__": >>> generate (Backends.polyorb_hi_ada);
main () '''
sys.exit (0); # exit libocarina_python.generate (Backends[generator]);
################################################################################ ################################################################################
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment