ocarina.py 10.2 KB
Newer Older
yoogx's avatar
yoogx committed
1
#! /usr/bin/python
2
3
4
5
6
7
8
9
10
11
'''
:mod:`ocarina` -- Python binding to the Ocarina AADL processor
==============================================================

.. moduleauthor:: Jerome Hugues

This module provides direct access to top-level functions of Ocarina
to load, parse, instantiate AADL models, and to invoke backends.

'''
yoogx's avatar
yoogx committed
12
13
14

################################################################################
import libocarina_python; # Ocarina bindings
15
16
import ocarina_me_aadl_aadl_instances_nodes as AIN; 
import ocarina_me_aadl_aadl_tree_nodes as ATN;
yoogx's avatar
yoogx committed
17

yoogx's avatar
yoogx committed
18
19
class Enum(tuple): __getattr__ = tuple.index

yoogx's avatar
yoogx committed
20
21
22
23
24
25
26
27
28
29
################################################################################
def version ():
    '''Print Ocarina version'''
    libocarina_python.version();

################################################################################
def status ():
    '''Print Ocarina status'''
    libocarina_python.status();

30
31
################################################################################
def reset ():
yoogx's avatar
yoogx committed
32
33
34
35
36
    '''Reset Ocarina internal state

    **Note:** this function must be called before processing a new set of models.
    '''

37
38
    libocarina_python.reset();

yoogx's avatar
yoogx committed
39
40
################################################################################
def load (filename):
yoogx's avatar
yoogx committed
41
42
43
44
45
46
47
48
49
50
    '''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");

    '''
yoogx's avatar
yoogx committed
51
52
53
54
55
56
57
58
59
    libocarina_python.load (filename);

################################################################################
def analyze ():
    '''Analyze models'''
    libocarina_python.analyze ();

################################################################################
def instantiate (root_system):
60
61
62
63
64
65
    '''Instantiate model, starting from root_system

    :param root_system: name of the root system to instantiate
    :type root_system: string

    '''
yoogx's avatar
yoogx committed
66
67
68
    libocarina_python.instantiate (root_system);

################################################################################
yoogx's avatar
yoogx committed
69
Backends = Enum ([ "polyorb_hi_ada", "polyorb_hi_c"]);
yoogx's avatar
yoogx committed
70
71
'''List of supported backends, used by :data:`generate`'''
# Note, this list should match backend names as specified by Ocarina CLI
yoogx's avatar
yoogx committed
72

yoogx's avatar
yoogx committed
73
def generate (generator):
yoogx's avatar
yoogx committed
74
    '''Generate code
yoogx's avatar
yoogx committed
75

yoogx's avatar
yoogx committed
76
77
78
    :param generator: one supported backends, from :data:`Backends`

    For instance, to use the PolyORB-HI/Ada backend, you may use the following
yoogx's avatar
yoogx committed
79

yoogx's avatar
yoogx committed
80
81
82
    >>> generate (Backends.polyorb_hi_ada);
    '''
    libocarina_python.generate (Backends[generator]);
yoogx's avatar
yoogx committed
83
84
85

################################################################################

86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
def getPackages ():
    '''Return the list of all the packages defined in the current AADL project
    '''
    return libocarina_python.getPackages();

################################################################################

def getImportDeclarations ():
    '''Return the list of all the import declaration used in the current AADL project
    '''
    return libocarina_python.getImportDeclarations();

################################################################################

def getAliasDeclarations ():
    '''Return the list of all the alias declaration defined in the current AADL project
    '''
    return libocarina_python.getAliasDeclarations ();

################################################################################

def getComponentTypes (category):
    '''Return a list of component types defined in the current AADL project

    :param category: one of the AADL category defined in the standard

    For instance, to retrieve all the system types from the current project,
    you may use the following

    >>> getComponentTypes (System);
    '''
    return libocarina_python.getComponentTypes (category);

################################################################################

def getComponentImplementations (category):
    '''Return a list of component implementations defined in the current AADL project

    :param category: one of the AADL category defined in the standard

    For instance, to retrieve all the system implementations from the current project,
    you may use the following

    >>> getComponentImplementations (System);
    '''
    return libocarina_python.getComponentImplementations (category);

################################################################################

def getAnnexes ():
    '''Return the list of all the annexes defined in the current AADL project
    '''
    return libocarina_python.getAnnexes ();

################################################################################

def getPrototypes ():
    '''Return the list of all the prototypes defined in the current AADL project
    '''
    return libocarina_python.getPrototypes ();

################################################################################

def getPrototypeBindings ():
    '''Return the list of all the prototype bindings defined in the current AADL project
    '''
    return libocarina_python.getPrototypeBindings ();

################################################################################

def getFlowSpecifications ():
    '''Return the list of all the flow specification defined in the current AADL project
    '''
    return libocarina_python.getFlowSpecifications ();

################################################################################

def getFlowImplementations ():
    '''Return the list of all the flow implementation defined in the current AADL project
    '''
    return libocarina_python.getFlowImplementations ();

################################################################################

def getModes ():
    '''Return the list of all the modes defined in the current AADL project
    '''
    return libocarina_python.getModes ();

################################################################################

def getModeTransitions ():
    '''Return the list of all the mode transition defined in the current AADL project
    '''
    return libocarina_python.getModeTransitions ();

################################################################################

def getInModes ():
    '''Return the list of all the in mode used in the current AADL project
    '''
    return libocarina_python.getInModes ();

################################################################################

def getPropertySets ():
    '''Return the list of all the property set defined in the current AADL project
    '''
    return libocarina_python.getPropertySets ();

################################################################################

def getPropertyTypes (propertySetId):
    '''Return the list of all the property types defined in the provided property set

    :param propertySetId: the nodeId of the property set in the current AADL project 
    to serach in

    For instance, to retrieve all the property types from property set propertySet, 
    retrieve its id (propertySetId) and use the following

    >>> getPropertyTypes (propertySetId);
    '''
    return libocarina_python.getPropertyTypes (propertySetId);

################################################################################

def getPropertyDefinitions (propertySetId):
    '''Return the list of all the property declaration defined in the provided property set

    :param propertySetId: the nodeId of the property set in the current AADL project 
    to serach in

    For instance, to retrieve all the property declaration from property set propertySet, 
    retrieve its id (propertySetId) and use the following

    >>> getPropertyDefinitions (propertySetId);
    '''
    return libocarina_python.getPropertyDefinitions (propertySetId);

################################################################################

def getPropertyConstants (propertySetId):
    '''Return the list of all the constant property defined in the provided property set

    :param propertySetId: the nodeId of the property set in the current AADL project 
    to serach in

    For instance, to retrieve all the constant property from property set propertySet, 
    retrieve its id (propertySetId) and use the following

    >>> getPropertyConstants (propertySetId);
    '''
    return libocarina_python.getPropertyConstants (propertySetId);

################################################################################

def getInstances (category):
    '''Return a list of instances defined in the current AADL project

    :param category: one of the AADL category defined in the standard

    For instance, to retrieve all the system instances from the current project,
    you may use the following

    >>> getInstances (System);
    '''
    return libocarina_python.getInstances (category);

################################################################################

def getComponentName (nodeId):
    '''Get the name of an AADL component

    :param nodeId: the id of the component whose name is searched

    For instance, to retrieve the name of MyComponent, 
    retrieve its id (nodeId) and use the following

    >>> getComponentName (nodeId);
    '''
    return libocarina_python.getComponentName (nodeId);

################################################################################

def getComponentFullname (nodeId):
    '''Get the full qualified name of an AADL component

    :param nodeId: the id of the component whose 
    full qualified name is searched

    For instance, to retrieve the full qualified name of MyComponent, 
    retrieve its id (nodeId) and use the following

    >>> getComponentFullname (nodeId);
    '''
    return libocarina_python.getComponentFullname (nodeId);

################################################################################

def getInstanceName (nodeId):
    '''Get the name of an AADL instance

    :param nodeId: the id of the instance whose name is searched

    For instance, to retrieve the name of MyInstance, 
    retrieve its id (nodeId) and use the following

    >>> getInstanceName (nodeId);
    '''
    return libocarina_python.getInstanceName (nodeId);

################################################################################

def getNodeId (name):
    '''Get the Id of a component from its name

    :param name: the AADL name of the node whose id is queried

    For instance, to retrieve the id of MyHome, you may use the following

    >>> getNodeId (MyHome);
    '''
    return libocarina_python.getNodeId (name);