Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ign -> gz Provisional Finale: Source Migration : gz-sensors #244

Merged
merged 2 commits into from
Jul 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/ci/packages.apt
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
libignition-cmake3-dev
libignition-common5-dev
libignition-math7-dev
libignition-msgs9-dev
libignition-rendering7-dev
libignition-tools2-dev
libignition-transport12-dev
libgz-cmake3-dev
libgz-common5-dev
libgz-math7-dev
libgz-msgs9-dev
libgz-rendering7-dev
libgz-tools2-dev
libgz-transport12-dev
libsdformat13-dev
xvfb
2 changes: 1 addition & 1 deletion .github/disabled_workflows/macos.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ jobs:
build:

env:
PACKAGE: ignition-sensors7
PACKAGE: gz-sensors7
runs-on: macos-latest
steps:
- uses: actions/checkout@v2
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ jobs:
uses: actions/checkout@v2
- name: Compile and test
id: ci
uses: ignition-tooling/action-ignition-ci@focal
uses: gazebo-tooling/action-gz-ci@focal
with:
codecov-enabled: true
cppcheck-enabled: true
Expand All @@ -24,4 +24,4 @@ jobs:
uses: actions/checkout@v2
- name: Compile and test
id: ci
uses: ignition-tooling/action-ignition-ci@jammy
uses: gazebo-tooling/action-gz-ci@jammy
2 changes: 1 addition & 1 deletion .github/workflows/pr-collection-labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ jobs:
steps:
- name: Add collection labels
if: github.event.action == 'opened'
uses: ignition-tooling/pr-collection-labeler@v1
uses: gazebo-tooling/pr-collection-labeler@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
6 changes: 2 additions & 4 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,7 @@ find_package(gz-cmake3 REQUIRED)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

gz_configure_project(
REPLACE_IGNITION_INCLUDE_PATH gz/sensors
VERSION_SUFFIX pre1)
gz_configure_project(VERSION_SUFFIX pre1)

#============================================================================
# Set project-specific options
Expand All @@ -41,7 +39,7 @@ message(STATUS "\n\n-- ====== Finding Dependencies ======")
#--------------------------------------
# Find Protobuf
set(REQ_PROTOBUF_VER 3)
gz_find_package(IgnProtobuf
gz_find_package(GzProtobuf
VERSION ${REQ_PROTOBUF_VER}
REQUIRED
PRETTY Protobuf)
Expand Down
2 changes: 1 addition & 1 deletion Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ release will remove the deprecated code.

### Additions

1. The core ignition-sensors library no longer depends on ign-rendering. All
1. The core gz-sensors library no longer depends on gz-rendering. All
rendering sensors and noise models are now part of the `rendering` component

1. New sensors: thermal camera
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Refer to the following table for information about important directories and fil

```
├── examples Example programs.
├── include/ignition/sensors Header files that will be installed.
├── include/gz/sensors Header files that will be installed.
├── src Source files and unit tests.
├── test
│   ├── integration Integration tests.
Expand Down
4 changes: 2 additions & 2 deletions api.md.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Gazebo @IGN_DESIGNATION_CAP@
## Gazebo @GZ_DESIGNATION_CAP@

Gazebo @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries
Gazebo @GZ_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries
designed to rapidly develop robot and simulation applications.

## License
Expand Down
5 changes: 0 additions & 5 deletions configure.bat

This file was deleted.

6 changes: 3 additions & 3 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
find_package(Doxygen)

set(IGNITION_DOXYGEN_TAGFILES
set(GZ_DOXYGEN_TAGFILES
"\"${GZ-MATH_DOXYGEN_TAGFILE} = ${GZ-MATH_API_URL}\" \
\"${GZ-MSGS_DOXYGEN_TAGFILE} = ${GZ-MSGS_API_URL}\" \
\"${GZ-TRANSPORT_DOXYGEN_TAGFILE} = ${GZ-TRANSPORT_API_URL}\" \
\"${GZ-COMMON_DOXYGEN_TAGFILE} = ${GZ-COMMON_API_URL}\""
)

if (DOXYGEN_FOUND)
configure_file(${IGNITION_CMAKE_DOXYGEN_DIR}/api.in
configure_file(${GZ_CMAKE_DOXYGEN_DIR}/api.in
${CMAKE_BINARY_DIR}/api.dox @ONLY)

configure_file(${IGNITION_CMAKE_DOXYGEN_DIR}/tutorials.in
configure_file(${GZ_CMAKE_DOXYGEN_DIR}/tutorials.in
${CMAKE_BINARY_DIR}/tutorials.dox @ONLY)

add_custom_target(doc ALL
Expand Down
2 changes: 1 addition & 1 deletion examples/imu_noise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This example creates a sequence of samples for an accelerometer and gyroscope ba
on the https://www.analog.com/media/en/technical-documentation/data-sheets/adis16448.pdf, a commonly-used MEMS IMU.

The sequence of samples can then be evaluated with Allan Variance to determine that
the noise generation in ign-sensors is working as expected.
the noise generation in gz-sensors is working as expected.

To evaluate noise, first build and run.

Expand Down
6 changes: 3 additions & 3 deletions examples/loop_sensor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ On another terminal, check that the altimeter and odometer are generating
data on a topic:

```
ign topic -l
gz topic -l
```

You should see:
Expand All @@ -51,7 +51,7 @@ You should see:
Then listen to the altimeter data:

```
ign topic -e -t /altimeter
gz topic -e -t /altimeter
```

You'll see data like:
Expand Down Expand Up @@ -79,7 +79,7 @@ vertical_velocity: 10.596832320931542
Then listen to the custom sensor:

```
ign topic -e -t /odometer
gz topic -e -t /odometer
```

You'll see data like:
Expand Down
8 changes: 4 additions & 4 deletions examples/save_image/main.cc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
#include <gz/common/Console.hh>
#include <gz/math/Helpers.hh>

// TODO(louise) Remove these pragmas once ign-rendering is disabling the
// TODO(louise) Remove these pragmas once gz-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
Expand Down Expand Up @@ -58,7 +58,7 @@ void BuildScene(gz::rendering::ScenePtr _scene);

int main()
{
// Setup ign-rendering with a scene
// Setup gz-rendering with a scene
#ifdef WITH_OGRE
auto engine = gz::rendering::engine("ogre");
#else
Expand All @@ -82,7 +82,7 @@ int main()

// Create SDF describing a camera sensor
const std::string name = "ExampleCamera";
const std::string topic = "/ignition/sensors/examples/save_image";
const std::string topic = "/gz/sensors/examples/save_image";
const double hz = 30;
const std::size_t width = 480;
const std::size_t height = 320;
Expand Down Expand Up @@ -133,7 +133,7 @@ int main()
return 0;
}

// Copy/paste from an gz-rendering example
// Copy/paste from a gz-rendering example
void BuildScene(gz::rendering::ScenePtr _scene)
{
// initialize _scene
Expand Down
2 changes: 1 addition & 1 deletion include/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
add_subdirectory(gz)
install(DIRECTORY ignition DESTINATION ${IGN_INCLUDE_INSTALL_DIR_FULL})
install(DIRECTORY ignition DESTINATION ${GZ_INCLUDE_INSTALL_DIR_FULL})
2 changes: 1 addition & 1 deletion include/gz/sensors/AltimeterSensor.hh
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ namespace gz
/// \brief Altimeter Sensor Class
///
/// An altimeter sensor that reports vertical position and velocity
/// readings over ign transport
/// readings over gz transport
class GZ_SENSORS_ALTIMETER_VISIBLE AltimeterSensor : public Sensor
{
/// \brief constructor
Expand Down
4 changes: 2 additions & 2 deletions include/gz/sensors/CameraSensor.hh
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
#pragma warning(pop)
#endif

// TODO(louise) Remove these pragmas once ign-rendering is disabling the
// TODO(louise) Remove these pragmas once gz-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
Expand Down Expand Up @@ -65,7 +65,7 @@ namespace gz
///
/// This class creates images from a Gazebo Rendering scene. The scene
/// must be created in advance and given to Manager::Init().
/// It offers both an ignition-transport interface and a direct C++ API
/// It offers both a gz-transport interface and a direct C++ API
/// to access the image data. The API works by setting a callback to be
/// called with image data.
class GZ_SENSORS_CAMERA_VISIBLE CameraSensor : public RenderingSensor
Expand Down
4 changes: 2 additions & 2 deletions include/gz/sensors/DepthCameraSensor.hh
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
#pragma warning(pop)
#endif

// TODO(louise) Remove these pragmas once ign-rendering is disabling the
// TODO(louise) Remove these pragmas once gz-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
Expand Down Expand Up @@ -65,7 +65,7 @@ namespace gz
///
/// This class creates depth image from a Gazebo Rendering scene.
/// The scene must be created in advance and given to Manager::Init().
/// It offers both an ignition-transport interface and a direct C++ API
/// It offers both a gz-transport interface and a direct C++ API
/// to access the image data. The API works by setting a callback to be
/// called with image data.
class GZ_SENSORS_DEPTH_CAMERA_VISIBLE DepthCameraSensor
Expand Down
4 changes: 2 additions & 2 deletions include/gz/sensors/GpuLidarSensor.hh
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

#include <gz/utils/SuppressWarning.hh>

// TODO(louise) Remove these pragmas once ign-rendering is disabling the
// TODO(louise) Remove these pragmas once gz-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
Expand Down Expand Up @@ -55,7 +55,7 @@ namespace gz
/// from the origin of the center to points on the visual geometry in the
/// scene.
///
/// It offers both an ignition-transport interface and a direct C++ API
/// It offers both a gz-transport interface and a direct C++ API
/// to access the image data. The API works by setting a callback to be
/// called with image data.
class GZ_SENSORS_GPU_LIDAR_VISIBLE GpuLidarSensor : public Lidar
Expand Down
2 changes: 1 addition & 1 deletion include/gz/sensors/ImageBrownDistortionModel.hh
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

#include <sdf/sdf.hh>

// TODO(WilliamLewww): Remove these pragmas once ign-rendering is disabling the
// TODO(WilliamLewww): Remove these pragmas once gz-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
Expand Down
2 changes: 1 addition & 1 deletion include/gz/sensors/ImageGaussianNoiseModel.hh
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

#include <sdf/sdf.hh>

// TODO(louise) Remove these pragmas once ign-rendering is disabling the
// TODO(louise) Remove these pragmas once gz-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
Expand Down
2 changes: 1 addition & 1 deletion include/gz/sensors/Lidar.hh
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ namespace gz
/// from the origin of the center to points on the visual geometry in the
/// scene.
///
/// It offers both an ignition-transport interface and a direct C++ API
/// It offers both a gz-transport interface and a direct C++ API
/// to access the image data. The API works by setting a callback to be
/// called with image data.
class GZ_SENSORS_LIDAR_VISIBLE Lidar : public RenderingSensor
Expand Down
2 changes: 1 addition & 1 deletion include/gz/sensors/RenderingEvents.hh
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
#include <gz/common/Event.hh>
#include <gz/utils/SuppressWarning.hh>

// TODO(louise) Remove these pragmas once ign-rendering is disabling the
// TODO(louise) Remove these pragmas once gz-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
Expand Down
2 changes: 1 addition & 1 deletion include/gz/sensors/RenderingSensor.hh
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

#include <gz/utils/SuppressWarning.hh>

// TODO(louise) Remove these pragmas once ign-rendering is disabling the
// TODO(louise) Remove these pragmas once gz-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
Expand Down
2 changes: 1 addition & 1 deletion include/gz/sensors/RgbdCameraSensor.hh
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ namespace gz
/// * Depth image (same as DepthCamera)
/// * (future / todo) Color point cloud
/// The scene must be created in advance and given to Manager::Init().
/// It offers both an ignition-transport interface and a direct C++ API
/// It offers both a gz-transport interface and a direct C++ API
/// to access the image data. The API works by setting a callback to be
/// called with image data.
class GZ_SENSORS_RGBD_CAMERA_VISIBLE RgbdCameraSensor
Expand Down
2 changes: 1 addition & 1 deletion include/gz/sensors/SegmentationCameraSensor.hh
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ namespace gz
///
/// This class creates segmentation images from a Gazebo Rendering scene.
/// The scene must be created in advance and given to Manager::Init().
/// It offers both an ignition-transport interface and a direct C++ API
/// It offers both a gz-transport interface and a direct C++ API
/// to access the image data. The API works by setting a callback to be
/// called with image data.
class GZ_SENSORS_SEGMENTATION_CAMERA_VISIBLE
Expand Down
2 changes: 1 addition & 1 deletion include/gz/sensors/Sensor.hh
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ namespace gz
/// information for this sensor.
public: sdf::ElementPtr SDF() const;

/// \brief Add a sequence number to an gz::msgs::Header. This
/// \brief Add a sequence number to a gz::msgs::Header. This
/// function can be called by a sensor that wants to add a sequence
/// number to a sensor message in order to have improved
/// accountability for generated sensor data.
Expand Down
2 changes: 1 addition & 1 deletion include/gz/sensors/SensorFactory.hh
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ namespace gz
///
/// This creates sensors by looking at the given SDF Sensor DOM
/// object.
/// Sensors created with this API offer an ignition-transport interface.
/// Sensors created with this API offer a gz-transport interface.
/// If you need a direct C++ interface to the data, you must get the
/// sensor pointer and cast to the correct type.
///
Expand Down
4 changes: 2 additions & 2 deletions include/gz/sensors/ThermalCameraSensor.hh
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
#pragma warning(pop)
#endif

// TODO(louise) Remove these pragmas once ign-rendering is disabling the
// TODO(louise) Remove these pragmas once gz-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
Expand Down Expand Up @@ -65,7 +65,7 @@ namespace gz
///
/// This class creates thermal image from a Gazebo Rendering scene.
/// The scene must be created in advance and given to Manager::Init().
/// It offers both an ignition-transport interface and a direct C++ API
/// It offers both a gz-transport interface and a direct C++ API
/// to access the image data. The API works by setting a callback to be
/// called with image data.
class GZ_SENSORS_THERMAL_CAMERA_VISIBLE ThermalCameraSensor
Expand Down
4 changes: 2 additions & 2 deletions include/gz/sensors/WideAngleCameraSensor.hh
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
#pragma warning(pop)
#endif

// TODO(louise) Remove these pragmas once ign-rendering is disabling the
// TODO(louise) Remove these pragmas once gz-rendering is disabling the
// warnings
#ifdef _WIN32
#pragma warning(push)
Expand Down Expand Up @@ -65,7 +65,7 @@ namespace gz
///
/// This class creates wide angle camera image from a Gazebo Rendering
/// scene. The scene must be created in advance and given to Manager::Init()
/// It offers both an ignition-transport interface and a direct C++ API
/// It offers both a gz-transport interface and a direct C++ API
/// to access the image data. The API works by setting a callback to be
/// called with image data.
class GZ_SENSORS_WIDE_ANGLE_CAMERA_VISIBLE WideAngleCameraSensor
Expand Down
2 changes: 1 addition & 1 deletion include/gz/sensors/sensors.hh.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
// Automatically generated
#include <gz/sensors/config.hh>
${ign_headers}
${gz_headers}
2 changes: 1 addition & 1 deletion src/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ set (gtest_sources
)

if (MSVC)
# TODO(louise) Remove this once warnings are suppressed in ign-rendering
# TODO(louise) Remove this once warnings are suppressed in gz-rendering
set_source_files_properties(
${rendering_sources}
SegmentationCameraSensor.cc
Expand Down
Loading