1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-05-08 22:37:04 +08:00

FindRTI: Update documentation

- Formatting and descriptions synced similar to other find modules.
- The `$Id$` attribute removed as other modules don't provide this.
  These were mostly used with SVN.  In Git, the `ident` attribute
  should be specified in `.gitattributes` to have it automatically
  replaced with hexadecimal blob object name.
- Mailing list email moved to internal comments.
- Links in internal comments updated.
This commit is contained in:
Peter Kokot 2025-03-25 02:26:41 +01:00
parent fd26efc2bd
commit 757c8d3427
No known key found for this signature in database
GPG Key ID: A94800907AA79B36

View File

@ -5,33 +5,43 @@
FindRTI
-------
Try to find M&S HLA RTI libraries
Finds HLA RTI standard libraries and their include directories.
This module finds if any HLA RTI is installed and locates the standard
RTI include files and libraries.
`RTI <https://en.wikipedia.org/wiki/Run-time_infrastructure_(simulation)>`_
(Run-Time Infrastructure) is a simulation infrastructure standardized by IEEE
and SISO, required when implementing HLA (High Level Architecture). It provides
a well-defined C++ API, ensuring that M&S (Modeling and Simulation) applications
remain independent of a particular RTI implementation.
RTI is a simulation infrastructure standardized by IEEE and SISO. It
has a well defined C++ API that assures that simulation applications
are independent on a particular RTI implementation.
Result Variables
^^^^^^^^^^^^^^^^
::
This module defines the following variables:
http://en.wikipedia.org/wiki/Run-Time_Infrastructure_(simulation)
``RTI_FOUND``
Set to FALSE if any HLA RTI was not found.
``RTI_LIBRARIES``
The libraries to link against to use RTI.
``RTI_DEFINITIONS``
Compile definitions for using RTI. Default value is set to
``-DRTI_USES_STD_FSTREAM``.
Cache Variables
^^^^^^^^^^^^^^^
The following cache variables may also be set:
This code sets the following variables:
``RTI_INCLUDE_DIR``
Directory where RTI include files are found.
::
Examples
^^^^^^^^
RTI_INCLUDE_DIR = the directory where RTI includes file are found
RTI_LIBRARIES = The libraries to link against to use RTI
RTI_DEFINITIONS = -DRTI_USES_STD_FSTREAM
RTI_FOUND = Set to FALSE if any HLA RTI was not found
Finding RTI:
.. code-block:: cmake
Report problems to <certi-devel@nongnu.org>
find_package(RTI)
#]=======================================================================]
macro(RTI_MESSAGE_QUIETLY QUIET TYPE MSG)
@ -43,8 +53,12 @@ endmacro()
set(RTI_DEFINITIONS "-DRTI_USES_STD_FSTREAM")
# noqa: spellcheck off
# Detect the CERTI installation, http://www.cert.fr/CERTI
# Detect the MAK Technologies RTI installation, http://www.mak.com/products/rti.php
# Detect the CERTI installation:
# - https://www.nongnu.org/certi/
# - Mailing list for reporting issues and development discussions:
# <certi-devel@nongnu.org>
# Detect the MAK Technologies RTI installation:
# - https://www.mak.com/mak-one/tools/mak-rti
# note: the following list is ordered to find the most recent version first
set(RTI_POSSIBLE_DIRS
ENV CERTI_HOME
@ -100,5 +114,3 @@ set(CMAKE_FIND_LIBRARY_PREFIXES "${RTI_OLD_FIND_LIBRARY_PREFIXES}")
include(FindPackageHandleStandardArgs)
find_package_handle_standard_args(RTI DEFAULT_MSG
RTI_LIBRARY RTI_INCLUDE_DIR)
# $Id$