Skip to content

Work with VS Code

Visual Studio Code (VS Code) is a popular code editor which can be customized by extensions (plug-ins). Since Artery is mostly a plain C++ project using CMake as its build tool, one can use VS Code instead of the Eclipse-based OMNeT++ IDE for development.

Requirements

Install VS Code along with its C/C++ and CMake Tools Extensions.

Building and Running Simulations

First, open Artery's folder with VS Code. Press Ctrl + Shfit + P to open VS Code's Command Palette and execute the following commands:

  1. CMake: Scan for Kits
  2. CMake: Select a Kit to select a compiler kit (GCC/Clang)
  3. CMake: Set Build Target and choose your scenario (in doubt: run_example)
  4. CMake: Build to start the simulation

Debugging Simulations

  1. Add launch.json to .vscode/. Adjust paths and arguments to your system/needs: 
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
    {
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "clang++ - Build and debug active file",
            "type": "cppdbg",
            "request": "launch",

            // Set path to OMNet++ debug runner
            "program": "<path>/omnetpp-5.6.2/bin/opp_run_dbg",

            // Set working directory to scenario
            "cwd": "${workspaceFolder}/scenarios/artery",

            "environment": [
                { "name": "ARTERY_HOME", "value": "<path>" }, // TODO: Add paths
                { "name": "OMNETPP_HOME", "value": "<path>" },
                { "name": "OMNETPP_ROOT", "value": "<path>" },
                { "name": "SUMO_HOME", "value": "<path>" }
            ],
            "args": [
                // Paths to NED files
                "-n${ARTERY_HOME}/src/artery:${ARTERY_HOME}/src/traci:${ARTERY_HOME}/extern/veins/examples/veins:${ARTERY_HOME}/extern/veins/src/veins:${ARTERY_HOME}/extern/inet/src:${ARTERY_HOME}/extern/inet/examples:${ARTERY_HOME}/extern/inet/tutorials:${ARTERY_HOME}/extern/inet/showcases",

                // Libraries used for Artery
                "-l${ARTERY_HOME}/build/src/artery/envmod/libartery_envmod.so",
                "-l${ARTERY_HOME}/build/extern/libINET.so",
                "-l${ARTERY_HOME}/build/extern/libveins.so",
                "-l${ARTERY_HOME}/build/src/artery/libartery_core.so",
                "-l${ARTERY_HOME}/build/src/traci/libtraci.so",
                // "-l${ARTERY_HOME}/build/scenarios/highway-police/libartery_police.so",

                // .ini file to of the scenario
                "omnetpp.ini",

                // OMNet++ config to run
                "-cenvmod",
                // Run number
                "-r0",

                // OMNet++ interface can either be Qtenv or Cmdenv
                //"-uQtenv",
                "-uCmdenv",
            ],
            "stopAtEntry": false,
            "externalConsole": false,
            "MIMode": "gdb",
            "setupCommands": [
                {
                    "description": "Enable pretty-printing for gdb",
                    "text": "-enable-pretty-printing",
                    "ignoreFailures": true
                },
                {
                    "description": "Enable all-exceptions",
                    "text": "catch throw",
                    "ignoreFailures": true
                }
            ],
            "preLaunchTask": "C/C++: clang++ build active file",
            "miDebuggerPath": "/usr/bin/gdb"
        }
    ]
}
  2. Add tasks.json to .vscode/ 
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    {
    "tasks": [
        {
            "type": "cppbuild",
            "label": "C/C++: clang++ build active file",
            "command": "/usr/bin/cmake",
            "args": [
                "--build",
                ".",
                "--parallel 6" // TODO: Enter number of threads to use 
            ],
            "options": {
                "cwd": "${workspaceFolder}/build"
            },
            "problemMatcher": [
                "$gcc"
            ],
            "group": {
                "kind": "build",
                "isDefault": true
            },
            "detail": "Generated task by Debugger"
        }
    ],
    "version": "2.0.0"
}
  3. Execute CMake: Select Variant and select Debug
  4. In case of doubt: execute CMake: Clean Rebuild
  5. Switch to debug view with Ctrl + Shfit + D
  6. Start debugging by pressing F5

Credits

Thanks to Alexander Willecke for contributing this page.

Last update: August 20, 2023