{"id":7782,"date":"2022-02-25T04:02:09","date_gmt":"2022-02-25T04:02:09","guid":{"rendered":"http:\/\/fastbitlab.com\/?p=7782"},"modified":"2023-08-24T16:59:54","modified_gmt":"2023-08-24T11:29:54","slug":"adding-files-in-qm-tool","status":"publish","type":"post","link":"https:\/\/fastbitlab.com\/blog\/adding-files-in-qm-tool\/","title":{"rendered":"FSM Lecture 50- Adding files in QM tool"},"content":{"rendered":"
\n
\n
\n
\n

 <\/p>\n<\/div>\n

\n

Adding files in QM tool<\/strong><\/span><\/h1>\n
\n
\n
\n

 <\/p>\n

<\/div>\n

 <\/p>\n<\/div>\n<\/div>\n<\/div>\n

This article will learn how to add files to the QM tool. Open a QM Model file using the QM tool. <\/span><\/p>\n

Let’s open the QM tool. And let’s open the model. Click on File\u2192  select Open Model. <\/span><\/p>\n

\"Figure
Figure 1. QM tool<\/span><\/figcaption><\/figure>\n

 <\/p>\n

\"Figure
Figure 2. QM Model File<\/span><\/figcaption><\/figure>\n

 <\/p>\n

When you open that QM model file, it should show ‘qpn’ here( Figure 3). Now we have to auto-generate the code for this model. The code can be generated into files. <\/span><\/p>\n

\"Figure
Figure 3. qpn file<\/span><\/figcaption><\/figure>\n

 <\/p>\n

You can mention the file names on the left-hand side, under which you want to generate the code.<\/span><\/p>\n

 <\/p>\n

When you load the 006QHsmTest project, the project already has two files here, shown in Figure 4. <\/span>qhsmtst.h<\/b>  header file and <\/span>qhsmtst.c<\/b> file.<\/span><\/span><\/p>\n

\"Figure
Figure 4. qhsmtst.h file<\/span><\/figcaption><\/figure>\n

 <\/p>\n

These files contain code generation directives of the QP framework to generate the code. So, using the directives, you can control what kind of code you want to generate. If you’re going to generate the function declarations, you can use the declare directive; if you’re going to generate the function definitions, you can define a directive like that.<\/span><\/p>\n

 <\/p>\n

\"Figure
Figure 5. qhsmtst.c file<\/span><\/figcaption><\/figure>\n

 <\/p>\n

We will do one thing: we will delete that file and create that once again to understand the usage of the code generation directives of the framework.<\/span><\/p>\n

 <\/p>\n

To create a directory, let’s click on the <\/span>qhsmtst<\/b> file and select Add directory, as shown in Figure 6.<\/span><\/span><\/p>\n

\"Figure
Figure 6. Creating a directory<\/span><\/figcaption><\/figure>\n

 <\/p>\n

You can mention the path of the directory. If you mention the ‘ . ‘, that signifies the directory in which this model file is present. That means, if you mention ‘ . ‘  in the directory path, it refers to the ‘qm’ folder in visual studio. Because under the ‘qm’ folder, we have the model file, as shown in Figure 7. That’s why this path is relative to the directory in which the model file is present. <\/span><\/p>\n

\"Figure
Figure 7. Mention the path of the directory<\/span><\/figcaption><\/figure>\n

 <\/p>\n

And to this \u2018.\u2019 directory, we can add files. <\/span><\/p>\n

    \n
  1. Right-click on the directory and click on Add File. <\/span><\/li>\n
  2. Give the name as ‘file.cpp’. You just created one file, <\/span>file.cpp<\/b>, in the current directory.<\/span><\/span><\/li>\n<\/ol>\n
    \"Figure
    Figure 8. Adding Files<\/span><\/figcaption><\/figure>\n

     <\/p>\n

    Suppose you want to see <\/span>the file.cpp<\/b> file, then you have to generate the code. Let’s click on generate code \u2192 Accept GPL, as shown in Figure 9. <\/span><\/span><\/p>\n

    \"Figure
    Figure 9. Generate code<\/span><\/figcaption><\/figure>\n

     <\/p>\n

    As you can see in Figure 10, one file is generated.<\/span><\/p>\n

    \"Figure
    Figure 10. Generated file<\/span><\/figcaption><\/figure>\n

     <\/p>\n

    You can see <\/span>the file.cpp<\/b> file under this ‘qm’ folder, as shown in Figure 11. It doesn’t contain any code because we have to use the code generation directives to include code. But, I don’t want to create any files here; rather, I want to create them under source. <\/span>Under source, I have already got ‘main.cpp’ and will create two files. <\/span><\/span><\/p>\n

    \"Figure
    Figure 11. file.cpp file under qm folder<\/span><\/figcaption><\/figure>\n

     <\/p>\n

    I’m going to create two files. <\/span><\/p>\n

    <\/b>1. QHSMTest_SM.c <\/span><\/b><\/span><\/p>\n

    StateMachine.c contains all the state machine implementation. That means state handler function definitions. Usually, state handler functions will be private to a file. That’s why you can keep them as static to a file.<\/span><\/p>\n

    You can also keep state handler function declarations in SM.c. <\/span><\/p>\n

    You can also use this file to keep any private variables related to the state machine.<\/span><\/p>\n

    For our project will create this as QHSMTest_SM.cpp.<\/span> <\/span><\/span><\/p>\n

     <\/p>\n

    2. <\/b>QHSMTest_SM.h <\/b><\/span><\/span><\/p>\n

    You can also create one StateMachine.h header file. Here, you keep everything you want to share with other files, like function declarations of exposed functions, event definitions like enum for events, etc. You can keep any details you want to share with other files in a state machine.h file.<\/span><\/p>\n

    \"Figure
    Figure 12. Adding files in QM tool<\/span><\/figcaption><\/figure>\n

     <\/p>\n

    Now, I create 2 files for qhsmtst model. One is a <\/span>QHSMTest_SM.cpp<\/span> and <\/span>QHSMTest_SM.h<\/span> file. <\/span><\/span>I want to keep those two files under the ‘src’ folder. <\/span><\/p>\n

    Now, you point this path to a different directory. What you can do is you can come out of the current directory using<\/span> ..\/<\/b>, you actually came out of the ‘qm’ directory and then point to the src directory. I’ll write  \u2018<\/span>..\/src<\/b>\u2019 here.<\/span><\/span><\/p>\n

    After that, let’s create two files in the <\/span>..\/src<\/b> directory. Click on that directory \u2192 select Add File. One file is  QHSM_Test.cpp, and another file QHSM_Test.h file. Save it and generate the code. And now you can see that two files have appeared under ‘src.’ <\/span><\/span><\/p>\n

    If you try to edit something here, you cannot save it. You can see that these files are marked as read-only files by the qm tool. You cannot edit anything here.<\/span><\/p>\n

    \"Figure
    Figure 13. QHSM_Test.cpp file<\/span><\/figcaption><\/figure>\n

     <\/p>\n

    There are two ways to edit the files that you have just created. One is using the external IDE. If you want to edit the files here, you have to mark the files as external, and then you cannot open these files under this software. Because this is an external file, you have to edit these files using external IDEs.<\/span><\/p>\n

    That’s why, if you want to edit the files using some external IDEs, then you have to tick the ‘external’ option for the files, as shown in Figure 14. <\/span><\/p>\n

    \"Figure
    Figure 14. Mark the file as external<\/span><\/figcaption><\/figure>\n

     <\/p>\n

    We have created two files. Now let’s understand how to generate the code. For that, you have to explore code generation directives. This will know by going through the documentation.<\/span><\/p>\n

    Go to <\/span> Quantum Leaps<\/span><\/span><\/a><\/span> website \u2192 Products\u2192 Documentation \u2192 and click on QM\u2122 Modeling Tool, as shown in Figure 15.<\/span><\/span><\/p>\n

    \"Figure
    Figure 15. Quantum Leaps website<\/span><\/figcaption><\/figure>\n

     <\/p>\n

    This is the complete documentation. Here go to Code Engineering and open the Code-Generation Directives.<\/span><\/p>\n

    \"Figure
    Figure 16. QM\u2122 Modeling Tool<\/span><\/figcaption><\/figure>\n

     <\/p>\n

    Code generation directives are nothing but some directives. I mean, directives to the QM tool to generate the code. You can fine-tune which code you want to generate and which code you don’t want to generate, all those things using these directives. These directives give a direction to the tool to generate the code.<\/span><\/p>\n

     <\/p>\n

    \"Figure
    Figure 17. Code-Generation Directives<\/span><\/figcaption><\/figure>\n

     <\/p>\n

    There are three major directives. <\/span><\/p>\n

      \n
    1. declare directive <\/span><\/li>\n
    2. define directive <\/span><\/li>\n
    3. define1 directive <\/span><\/li>\n<\/ol>\n