Welcome to mpi_cmake_modules’s documentation!

Readme

Introduction

This package mpi_cmake_modules defines a list of usefull cmake macros. It can be used by simply depending on it using ament. The documentation can be seen here

Getting started

In order to use the CMake macros contained in this package one need to depend on it in the following way:

find_package(mpi_cmake_module REQUIRED)

Note: This will perform by default:

• the define_os() macro defined in cmake/os_detection.cmake

• the setup_xenomai() macro defined in the cmake/xenomai.cmake if the OS Xenomai is detected.

License

BSD 3-Clause unless specified differently in the file header

Authors

• Vincent Berenz (vberenz@tue.mpg.de)

• Maximilien Naveau (mnaveau@tue.mpg.de)

• Felix Widmaier (fwidmaier@tue.mpg.de)

General Documentation

• General Documentation
  • Boost
  • Cereal (serialization)
  • Clang Format
  • Doxygen
  • Dynamic graph
  • Eigen (linear algebra)
  • OS detection
  • Pthread
  • Python
  • Xacro

Python API

• mpi_cmake_modules
  • mpi_cmake_modules package
    • Submodules
    • Module contents

• Module Index

CMake API

• CMake API
  • install_scripts
  • documentation
  • sphinx
  • xacro
  • xenomai
  • find_modules
  • get_python_install_dir
  • global_calls
  • generate_cmake_package
  • get_python_interpreter
  • pybind11
  • dynamic_graph
  • os_detection
  • doxygen
  • boost_python
  • print_target_properties

Indices and Tables

• Index

• Search Page

License and Copyrights

BSD 3-Clause License

Copyright (c) 2019, New York University and Max Planck Gesellschaft. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.