inet.simulation.build
=====================

.. py:module:: inet.simulation.build

.. autoapi-nested-parse::

   This module provides functionality for building simulation projects.

   The main function is :py:func:`build_project`.



Classes
-------

.. toctree::
   :hidden:

   /python-api/inet/simulation/build/BuildSimulationProjectTask
   /python-api/inet/simulation/build/CopyBinaryTask
   /python-api/inet/simulation/build/MultipleBuildTasks
   /python-api/inet/simulation/build/MultipleCppCompileTasks
   /python-api/inet/simulation/build/MultipleMsgCompileTasks

.. autoapisummary::

   inet.simulation.build.BuildSimulationProjectTask
   inet.simulation.build.CopyBinaryTask
   inet.simulation.build.MultipleBuildTasks
   inet.simulation.build.MultipleCppCompileTasks
   inet.simulation.build.MultipleMsgCompileTasks


Functions
---------

.. autoapisummary::

   inet.simulation.build.build_project
   inet.simulation.build.build_project_using_makefile
   inet.simulation.build.build_project_using_tasks


Module Contents
---------------

.. py:function:: build_project(build_mode='makefile', **kwargs)

   Builds all output files of a simulation project using either :py:func:`build_project_using_makefile` or :py:func:`build_project_using_tasks`.

   :param build_mode: Specifies the requested build mode. Valid values are "makefile" and "task".
   :type build_mode: string
   :param kwargs: Additional parameters are inherited from :py:func:`build_project_using_makefile` and :py:func:`build_project_using_tasks` functions.
   :type kwargs: dict

   Returns (None):
       Nothing.


.. py:function:: build_project_using_makefile(simulation_project=None, mode='release', **kwargs)

   Builds a simulation project using the Makefile generated by the command line tool :command:`opp_makemake`. The
   output files include executables, dynamic libraries, static libraries, C++ object files, C++ message file headers
   and their implementations, etc.

   :param simulation_project: The simulation project to build. If unspecified, then the default simulation project is used.
   :type simulation_project: :py:class:`SimulationProject <inet.simulation.project.SimulationProject>`
   :param mode: Specifies the build mode of the output binaries. Valid values are "debug" and "release".
   :type mode: string

   Returns (None):
       Nothing.


.. py:function:: build_project_using_tasks(simulation_project, **kwargs)

   Builds all output files of a simulation project using tasks. The output files include executables, dynamic libraries,
   static libraries, C++ object files, C++ message file headers and their implementations, etc.

   :param simulation_project: The simulation project to build. If unspecified, then the default simulation project is used.
   :type simulation_project: :py:class:`SimulationProject <inet.simulation.project.SimulationProject>`
   :param kwargs: Additional parameters are inherited from the constructor of :py:class:`BuildSimulationProjectTask`.
   :type kwargs: dict

   Returns (None):
       Nothing.