telPluginDocumentation.py

This example shows

1. How to extract a plugins embedded PDF documentation

from teplugins import *

try:
    
    #Create a plugin manager
    pm = createPluginManager()
    
    pluginName = "tel_add_noise" #"tel_levenberg_marquardt"
    plugin = loadPlugin(pm, pluginName)
    if not plugin:
        print getLastError()
        exit()
    
    #Get some general info about the plugin
    print getPluginInfo(plugin)
    
    #Get parameters associated with a capability
    print getListOfPluginPropertyNames(plugin)
    
    #Get the manual for the plugin (bundled as embedded PDF)
    ptr = getPluginManualAsPDF(plugin)
    nrOfBytes = getPluginManualNrOfBytes(plugin)
    manual = cast(ptr, POINTER(c_char * nrOfBytes))[0]
    
    #Check if there is a PDF available
    if nrOfBytes == 0:
        print 'This plugin does not have a manual.'
        exit()
    
    #create a (temporary) pdf file from the data
    outFName = pluginName + '.pdf'
    
    with open(outFName, 'wb') as output:
        output.write(manual)
        
    os.system('start ' + outFName) #a total guess
except Exception as e:
    print 'Problem: ' + `e`