KDIS

Open source implementation of DIS (Distributed Interactive Simulation) IEEE 1278.1

Contributing

I would love to see your contribution ❤️

See CONTRIBUTING guidelines

Development

Requirements

Name	Homepage	Required	Notes
CXX Compiler		✔️	GCC | Clang | MSVC
CMake	https://cmake.org	✔️	Version >= 3.14
Clang Format	https://clang.llvm.org/docs/ClangFormat.html	❌
Clang Tidy	https://clang.llvm.org/extra/clang-tidy	❌
Cppcheck	https://github.com/danmar/cppcheck	❌
Cpplint	https://github.com/cpplint/cpplint	❌	pip install cpplint
cmake lang	https://github.com/cheshirekow/cmake_format	❌	pip install cmakelang[YAML]
Doxygen	https://www.doxygen.nl	❌	Documentation

Build Options

Name	Description	Type	Default
DIS_VERSION	DIS version: 5 IEEE 1278.1-1995 6 IEEE 1278.1A-1998 7 IEEE 1278.1x-2012	STRING	7
KDIS_USE_ENUM_DESCRIPTORS	Enumeration descriptors. Allow enum values to be turned into their text labels. ⚠️ Increase the memory footprint of the library	BOOL	TRUE
KDIS_BUILD_DOCS	Build documentation	BOOL	FALSE
KDIS_BUILD_EXAMPLES	Build examples	BOOL	FALSE
KDIS_BUILD_TESTS	Build tests	BOOL	FALSE
BUILD_SHARED_LIBS	Build shared library	BOOL	TRUE

Build

1. Generate project

   [!NOTE] Change build options' values as needed

   cmake \
       -S . \
       -B ./build \
       -DCMAKE_BUILD_TYPE:STRING=Release \
       -DDIS_VERSION:STRING=7 \
       -DKDIS_USE_ENUM_DESCRIPTORS:BOOL=TRUE \
       -DBUILD_SHARED_LIBS:BOOL=TRUE \
       -DBUILD_DOCS:BOOL=FALSE \
       -DBUILD_EXAMPLES:BOOL=FALSE \
       -DBUILD_TESTS:BOOL=FALSE

2. Build project

   [!NOTE] Change value of --config to match value of CMAKE_BUILD_TYPE

   cmake \
       --build ./build \
       --config Release

Documentation

Important

KDIS_BUILD_DOCS:BOOL=TRUE required

File index.html available under build/docs/html directory

More information can be found in docs/README.md

Examples

Important

KDIS_BUILD_EXAMPLES:BOOL=TRUE required

More information can be found in examples/README.md

Scripts

More information can be found in scripts/README.md

Tests

Important

KDIS_BUILD_TESTS:BOOL=TRUE required

Note

Change value of --build-config to match value of CMAKE_BUILD_TYPE

ctest \
    --verbose \
    --test-dir ./build/tests \
    --build-config Release

More information can be found in tests/README.md

License

This project is licensed under the BSD 2-Clause "Simplified" License
See LICENSE file for details