StateMachine API Main Page

Description

This is IAR Visual State StateMachine API version 1.0. This API can be used for loading, creating, editing and saving IAR Visual State StateMachine files. Refer also to the generated header file and source documentation for information on usage.

Connecting to the API

Here is a description of how to connect to the API from C or C++. If you are using another language you can use the files shown here to write your own code to connect to the API. Connecting to the API from C or C++

External functions used in the example code

The examples use some classes and functions that are not part of the API.

• FilePath is a class which represents a full file path. You can use any way to represent paths to files. Prefer to call with a full path to the API when you need to specify a file name. The API will change all full paths to topstate files to relative paths to the project when saving the project.
• testASSERT is a function or macro that asserts if the argument is 0. You should always check the returned value from a call to an API function. See also VSMGetErrorStringPtr().

Examples of use

Below there are some links to some examples of how to use the API.

• Creating a new project, a new system, and a new topstate
• Finding some vertex and deleting it
• Renaming some action function in the project
• Example of working with a state machine
• Example of creating a project with element folders
• Example of loading a project with element folders

Shortcut links

Below there are some direct links to the documentation of the API.

• Link to data structures
• Link to macros
• Link to typedefs
• Link to enumerations
• Link to functions

History of changes

See below for a a link to the history of changes to the API.

• History of changes