Skip to content

Interface

The interface is the first layer of the Python API. It consists of C++ libraries (stored in .pyd files) containing internal ALLPLAN classes and functions, that were exposed to Python. The source code of this part is compiled and cannot be accessed directly.

Browsing the reference

  • The entries in the navigation tree, as well in the table of content are labeled according to their type

    • is a module
    • is a class
    • is a function
    • is a method
    • is an attribute
  • The navigation tree on the left reflects the structure of the framework's modules and classes

    Example

    • Module A

      • Class A
      • Class B
    • Module B

      • Submodule C

        • Class D
        • Class E

    To import the classes shown in the navigation tree on the left, implement the imports as follows:

    from ModuleA import ClassA, ClassB
    from ModuleB.SubmoduleC import ClassD, ClassE
    
  • The module-level functions () are all documented on the module's summary page, whereas classes () of a module are documented each on a separate page. However, if a module contain only one class, then this class is documented on the module's summary page as well.

Placeholder