CCPN
Help

How is this API documentation organized?

    This API (Application Programming Interface) document has pages corresponding to the items in the top navigation bar, described as follows. From where you are, there are different activated links in the top navigation bar.

    Home

      The Home page is the front page of this Python API document and provides a list of all packages with a summary for each.

    Package

      From the Home page, you can go to a Package page that contains packages ('Directly Contained packages') as 'ccp', 'ccpnmr' and 'memops' or you can go to a Package page that contains classes ('All Contained packages').

      For each package page, the links '{ prev | next }' are activated to access previous and next package related to the current one.

      Each package has a page that contains a list of its classes, with a summary for each. This page can contain three categories: the 'Abstract Class Summary', the 'Class Summary' and the 'Data Types'.

    Class

      Each abstract class, class and data type has its own separate page. Each of these pages can contain four sections consisting of a class description with a summary, attribute tables, method tables and appendix.

      For each class page, the links '{ prev | next }' are activated to access previous and next class related to the current one.

    Attribute

      Each attribute and link attribute has its own separate page. Each of these pages has two sections consisting of an attribute summary and a description table.

    Method

      Some of the access and other methods have their own separate page.


    Diagram

      The class diagram related to the current package.

    Class map

      The list of all the classes in alphabetic order.

    Help

      The help page.

www.ccpn.ac.uk
Work done by the CCPN team.
Last modified: Wed Sep 17 13:26:08 BST 2003