MicroC Code Generator : OS Definition Tool : APIs

APIs

This section describes the various APIs, according to their location.

Code Style
The Condition Buffer User-Type Name(): API is located under the “Code Style Page --> Types Naming Style” page. It is available with the ‘default’ OSI and can be loaded to the existing OSI using the “Update From OSI” under the OSDT File menu.
Description
Defines the name of the User-Defined-Type that is used as the type of the buffer generated for Conditions in the Code-Generator's mode: 'Use Separate Buffer for: Conditions' (See the Code-Generator Property-Sheet, General Tab).

The following APIs have a Tab named “Internal Data-Types” in the “API Definitions” page. These APIs are available with the ‘default’ OSI and can be loaded to the existing OSI using the “Update From OSI” under the OSDT File menu.

Condition Buffer User-Type Type():

This API defines the type of the User-Define-Type used when generating the Conditions in the 'Buffer per Condition' Mode.
Event Buffer Type():

This API defines the type of the Buffer used when generating the Events in the 'Buffer per Event' Mode.
Default Signed Integer Type():

This API defines the default integer signed type. It overrides the definition in the Code-Generator property-Sheet.
Default Unsigned Integer Type():

This API defines the default integer signed type. It overrides the definition in the Code-Generator property-Sheet.
Default Floating Point Type():

This API defines the default Floating Point type. It overrides the definition in the Code-Generator property-Sheet.
Bit Field Type():

This API defines the Dada-Type used for Conditions and Bit Data-Items, when generating Conditions/Bits without macros. It overrides the definition in the Code-Generator property-Sheet:

The following APIs, located in the Code-Style tab, can use the full syntax of the OS Customization Tool ($<..> and ?<..>). The parameter activityNameid is passed to some of the APIs and refers to the owner Activity. The parameter udt_or_activity_nameid is passed to some of the APIs and refers to the owner of the buffer (an Activity or a User-Defined Type). The syntax $<...> and ?<...> can be used in the APIs with the element’s Attributes. The Attributes see the element that owns or requests the corresponding API. The APIs are as follows:

The Profile .c File Header(profileName, fileName, genDate, genTime,profileOptions, Project, Workarea, profileVersion) API is located in the Default OSI: Code Style Page -> File Header/Footer.

This API controls the header of the <profile name>.c file. When checked, the tool looks for the related key word (originated from the OSI user_code.c file) and replaces it with the API definition. The definition of the API is inserted either in the beginning of the file <profile>.c, or in the location marked by the keyword: /* keywordfor <profile>.c header */.

The following APIs (Code-Style page) define the timeout naming method.

The following APIs (defined in the DEFAULT OSI) are accessible from the Get/Set Functions tab in the API Definitions... page.

The following APIs (available in the DEFAULT OSI and located in Code Style -> FileHeader/Footer) allow customizing of the <profile>.h header and footer:

Generated Profile H File Header(profileName, fileName, genDate, genTime,profileOptions, project, workarea, profileVersion)
Generated Profile H File Footer(profileName, fileName, genDate, genTime,profileOptions, Project, Workarea, profileVersion)

The following APIs define the generated code naming conventions. They allow control over the actual names and not only the prefix (as the pre-existing APIs did).