inet.simulation.project.SimulationProject¶
-
class inet.simulation.project.SimulationProject(name, version, git_hash=
None, git_diff_hash=None, folder_environment_variable=None, folder='.', omnetpp_environment_variable='__omnetpp_root_dir', bin_folder='.', library_folder='.', executables=None, dynamic_libraries=None, static_libraries=None, build_types=['dynamic library'], ned_folders=['.'], ned_exclusions=[], ini_file_folders=['.'], python_folders=['python'], image_folders=['.'], include_folders=['.'], cpp_folders=['.'], cpp_defines=[], msg_folders=['.'], media_folder='.', statistics_folder='.', fingerprint_store='fingerprint.json', speed_store='speed.json', used_projects=[], external_bin_folders=[], external_library_folders=[], external_libraries=[], external_include_folders=[], simulation_configs=None, **kwargs)¶ Represents a simulation project that usually comes with its own modules and their C++ implementation, and also with several example simulations.
Please note that undocumented features are not supposed to be called by the user.
Initializes a new simulation project.
- Parameters:¶
- name : string¶
The human readable name of the simulation project.
- version : string or None¶
The version string.
- git_hash : string or None¶
The git hash of the corresponding git repository for the specific version.
- git_diff_hash : string¶
The hash of the local modifications on top of the clean checkout of from the git repository.
- folder_environment_variable : string¶
The operating system environment variable.
- omnetpp_environment_variable : string¶
The operating system environment variable specifying the root folder of the omnetpp installation.
- folder : string¶
The directory of the simulation project relative to the value of the folder_environment_variable attribute.
- bin_folder : string¶
The directory of the binary output files relative to the value of the folder_environment_variable attribute.
- library_folder : string¶
The directory of the library output files relative to the value of the folder_environment_variable attribute.
- executables : List of strings¶
The list of executables that are built.
- dynamic_libraries : List of strings¶
The list of dynamic libraries that are built.
- static_libraries : List of strings¶
TODO
- build_types : List of strings¶
The list of build output types. Valid values are “executable”, “dynamic library”, “static library”.
- ned_folders : List of strings¶
The list of folder_environment_variable relative directories for NED files.
- ned_exclusions : List of strings¶
The list of excluded NED packages.
- ini_file_folders : List of strings¶
The list of folder_environment_variable relative directories for INI files.
- python_folders : List of strings¶
The list of folder_environment_variable relative directories for Python source files.
- image_folders : List of strings¶
The list of folder_environment_variable relative directories for image files.
- include_folders : List of strings¶
The list of folder_environment_variable relative directories for C++ include files.
- cpp_folders : List of strings¶
The list of folder_environment_variable relative directories for C++ source files.
- cpp_defines : List of strings¶
The list of C++ macro definitions that are passed to the C++ compiler.
- msg_folders : List of strings¶
The list of folder_environment_variable relative directories for MSG files.
- media_folder : String¶
The relative path of chart image files for chart tests.
- statistics_folder : String¶
The relative path of scalar statistic result files for statistical tests.
- fingerprint_store : String¶
The relative path of the JSON fingerprint store for fingerprint tests.
- speed_store : String¶
The relative path of the JSON measurement store for speed tests.
- used_projects : List of strings¶
The list of used simulation project names.
- external_bin_folders : List of strings¶
The list of absolute directories that contains external binaries.
- external_library_folders : List of strings¶
The list of absolute directories that contains external libraries.
- external_libraries : List of strings¶
The list external library names.
- external_include_folders : List of strings¶
The list of absolute directories that contains external C++ include files.
- simulation_configs=
None¶ The list of simulation configs available in this simulation project.
- kwargs : dict¶
Ignored.