Introduction

This overview will give you a general idea about how we have designed our API hierarchy and related classes. You will be more comfortable to use them after reading the information below.

• API via Python
• What do you need to know?
• Structure
• Using an IDE
• Enum data type
• Using the API documents

API via Python
We provide API classes mainly in Python language (other languages may be provided base on the product). We use OOP (object oriented programming) approach. Thus we provide classes instead of only functions. As a huge benefit of this approach you can easily extend your tool set by inheriting the classes we provide.

 

What do you need to know?
Since we provide not only Python functions but Python classes, having some OOP knowledge is essential. If you have OOP experience you will be very comfortable with the API classes we provide.

If you have ever worked with C++ language before, you will find our API documents very easy to use. Since we are C++ developers as well, we always use Doxygen style documentation and we wanted to offer same style documentation to our costumers even the language is Python. We have developed our own document creator tool so as a result API documents come in Doxygen style. We believe that it’s a good benefit for a developer who has C++ background.

 

Structure
API structure is based on namespaces. Each name space represents related modules. Each module contains relevant class or classes. You can import the module you desired by using its absolute path.

We provide extensive API documentation along side of code examples. You can learn which namespaces are available by checking out the related API document page.

 

Using an IDE
IDE stands for “Integrated Development Environment” and many can be found both free and paid on the internet. We strongly advise you to use an IDE with auto-complete feature so you can interact with the API classes faster. A proper IDE will allow you to navigate in module and class hierarchies easily and you can reach API documentation instantly as well.

You can check following link for the list of the IDEs.

http://wiki.python.org/moin/IntegratedDevelopmentEnvironments?action=show&redirect=IDE

 

Enum Data Type
We provide public static members in some classes to mimic enum data type in Python that we always use in C++. For instance; tronverte.storm.pipeline module has a class named ControlColor. This class holds the pre-defined color data for the controls in a rig. Public static members of this class need to be passed where appropriate in order to maintain consistency.