inet.simulation.build

This module provides functionality for building simulation projects.

The main function is build_project().

Classes

BuildSimulationProjectTask

Represents a task that builds a simulation project.

Functions

build_project([build_mode])

Builds all output files of a simulation project using either build_project_using_makefile() or build_project_using_tasks().

build_project_using_makefile([simulation_project, mode])

Builds a simulation project using the Makefile generated by the command line tool opp_makemake. The

build_project_using_tasks(simulation_project, **kwargs)

Builds all output files of a simulation project using tasks. The output files include executables, dynamic libraries,

Module Contents

inet.simulation.build.build_project(build_mode='makefile', **kwargs)

Builds all output files of a simulation project using either build_project_using_makefile() or build_project_using_tasks().

Parameters:
build_mode : string

Specifies the requested build mode. Valid values are “makefile” and “task”.

kwargs : dict

Additional parameters are inherited from build_project_using_makefile() and build_project_using_tasks() functions.

Returns (None):

Nothing.

inet.simulation.build.build_project_using_makefile(simulation_project=None, mode='release', **kwargs)

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

Parameters:
simulation_project=None

The simulation project to build. If unspecified, then the default simulation project is used.

mode : string

Specifies the build mode of the output binaries. Valid values are “debug” and “release”.

Returns (None):

Nothing.

inet.simulation.build.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.

Parameters:
simulation_project

The simulation project to build. If unspecified, then the default simulation project is used.

kwargs : dict

Additional parameters are inherited from the constructor of BuildSimulationProjectTask.

Returns (None):

Nothing.