1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# Ignition Utils : Classes and functions for robot applications
**Maintainer:** addisu AT openrobotics DOT org
[](https://github.com/ignitionrobotics/ign-utils/issues)
[](https://github.com/ignitionrobotics/ign-utils/pulls)
[](https://community.gazebosim.org)
[](https://www.apache.org/licenses/LICENSE-2.0)
Build | Status
-- | --
Test coverage | [](https://codecov.io/gh/ignitionrobotics/ign-utils)
Ubuntu Bionic | [](https://build.osrfoundation.org/job/ignition_utils-ci-main-bionic-amd64)
Homebrew | [](https://build.osrfoundation.org/job/ignition_utils-ci-main-homebrew-amd64)
Windows | [](https://build.osrfoundation.org/job/ign_utils-ci-win/)
Ignition Utils, a component of [Ignition
Robotics](https://ignitionrobotics.org), provides general purpose
classes and functions designed for robotic applications.
# Table of Contents
[Features](#features)
[Install](#install)
[Usage](#usage)
[Documentation](#documentation)
[Testing](#testing)
[Folder Structure](#folder-structure)
[Code of Conduct](#code-of-conduct)
[Contributing](#code-of-contributing)
[Versioning](#versioning)
[License](#license)
# Features
Ignition Utils provides a wide range of functionality, including:
* A helper class to implement the PIMPL pattern
* A command line parsing utility (vendored [CLI11](https://github.com/CLIUtils/CLI11/))
* Macros to suppress warnings
# Install
See the [installation tutorial](https://ignitionrobotics.org/api/utils/0.1/install.html).
# Usage
Please refer to the [examples directory](https://github.com/ignitionrobotics/ign-utils/blob/main/examples/).
# Documentation
API and tutorials can be found at [https://ignitionrobotics.org/libs/utils](https://ignitionrobotics.org/libs/utils).
You can also generate the documentation from a clone of this repository by following these steps.
1. You will need Doxygen. On Ubuntu Doxygen can be installed using
```
sudo apt-get install doxygen
```
2. Clone the repository
```
git clone https://github.com/ignitionrobotics/ign-utils
```
3. Configure and build the documentation.
```
cd ign-utils; mkdir build; cd build; cmake ../; make doc
```
4. View the documentation by running the following command from the build directory.
```
firefox doxygen/html/index.html
```
# Testing
Follow these steps to run tests and static code analysis in your clone of this repository.
1. Follow the [source install instruction](https://ignitionrobotics.org/libs/utils#source-install).
2. Run tests.
```
make test
```
3. Static code checker.
```
make codecheck
```
# Folder Structure
Refer to the following table for information about important directories and files in this repository.
```
ign-utils
├── examples Example programs.
├── include/ignition/utils Header files.
├── src Source files and unit tests.
├── test
│ ├── integration Integration tests.
│ ├── performance Performance tests.
│ └── regression Regression tests.
├── tutorials Tutorials, written in markdown.
├── Changelog.md Changelog.
└── CMakeLists.txt CMake build script.
```
# Contributing
Please see
[CONTRIBUTING.md](https://ignitionrobotics.org/docs/all/contributing).
# Code of Conduct
Please see
[CODE_OF_CONDUCT.md](https://github.com/ignitionrobotics/ign-utils/blob/main/CODE_OF_CONDUCT.md)
# Versioning
This library uses [Semantic Versioning](https://semver.org/).
Additionally, this library is part of the
[Ignition project](https://ignitionrobotics.org) which periodically
releases a versioned set of compatible and complimentary libraries. See the
[Ignition website](https://ignitionrobotics.org) for version and
release information.
# License
This library is licensed under
[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
See also the
[LICENSE](https://github.com/ignitionrobotics/ign-utils/blob/main/LICENSE)
file.
|
