API naming scheme

The API has been designed following a consistent naming scheme. First of all, all the APIs work on object handles. Such handles should be considered opaque. Functions are provided to operate on the object (e.g. to set a parameter of a board or retrieve the name of a port). The main objects of the library are

All the functions are named following a consistent naming scheme in the form

Tc<object name><operation><parameter>

For example, the function to get the unique name of a port is called TcPortGetName. The operation is usually Set, Query or Get.

A number of functions have a global scope i.e. they do not operate on a specific object. In this case the <object name> part is absent. Global functions are listed in section Global functions.


TurboCap API documentation. Copyright (c) 2007-2008 CACE Technologies. All rights reserved.