lmp.py 8.83 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 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
#! /usr/bin/python
'''
:mod:`lmp`

.. moduleauthor:: Jerome Hugues, Arnaud Schach

Port of Ellidiss LMP to Ocarina Python API

'''

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

try:
    import libocarina_python # Ocarina bindings
    import ocarina_me_aadl_aadl_instances_nodes as AIN
    import ocarina_me_aadl_aadl_tree_nodes as ATN
    from ocarina_common_tools import *
    import io
except ImportError:
    pass

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

def getPackages ():
    '''Return the list of all the packages defined in the current AADL project
    '''

    return runOcarinaFunction (libocarina_python.getPackages)

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

def getImportDeclarations ():
    '''Return the list of all the import declarations used in the
    current AADL project
    '''

    return runOcarinaFunction (libocarina_python.getImportDeclarations)

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

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

    return runOcarinaFunction (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 runOcarinaFunction (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 runOcarinaFunction (libocarina_python.getComponentImplementations, category)

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

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

    return runOcarinaFunction (libocarina_python.getAnnexes)

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

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

    return runOcarinaFunction (libocarina_python.getPrototypes)

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

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

    return runOcarinaFunction (libocarina_python.getPrototypeBindings)

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

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

    return runOcarinaFunction (libocarina_python.getFlowSpecifications)

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

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

    return runOcarinaFunction (libocarina_python.getFlowImplementations)

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

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

    return runOcarinaFunction (libocarina_python.getModes)

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

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

    return runOcarinaFunction (libocarina_python.getModeTransitions)

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

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


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

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

    return runOcarinaFunction (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 search in

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

    >>> getPropertyTypes (propertySetId)
    '''

    return runOcarinaFunction (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 search in

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

    >>> getPropertyDefinitions (propertySetId)
    '''

    return runOcarinaFunction (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 search in

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

    >>> getPropertyConstants (propertySetId)

    '''

    return runOcarinaFunction (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 runOcarinaFunction (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 runOcarinaFunction (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 runOcarinaFunction (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 runOcarinaFunction (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 runOcarinaFunction (libocarina_python.getNodeId, name)

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

def getRoot ():
    '''Get the Id of the current root instantiated model
    '''

    return runOcarinaFunction (libocarina_python.getRoot)