Gazebo Gazebo

API Reference

6.16.0
RFComms.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2022 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #ifndef IGNITION_GAZEBO_SYSTEMS_RFCOMMS_HH_
18 #define IGNITION_GAZEBO_SYSTEMS_RFCOMMS_HH_
19 
20 #include <memory>
21 
22 #include <gz/utils/ImplPtr.hh>
23 #include <sdf/Element.hh>
25 #include "gz/sim/System.hh"
26 
27 namespace ignition
28 {
29 namespace gazebo
30 {
31 // Inline bracket to help doxygen filtering.
32 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
33 namespace systems
34 {
82  class RFComms
83  : public comms::ICommsModel
84  {
86  public: explicit RFComms();
87 
89  public: ~RFComms() override = default;
90 
91  // Documentation inherited.
92  public: void Load(const Entity &_entity,
95  EventManager &_eventMgr) override;
96 
97  // Documentation inherited.
98  public: void Step(const ignition::gazebo::UpdateInfo &_info,
99  const comms::Registry &_currentRegistry,
100  comms::Registry &_newRegistry,
101  EntityComponentManager &_ecm) override;
102 
104  IGN_UTILS_UNIQUE_IMPL_PTR(dataPtr)
105  };
106  }
107 }
108 }
109 }
110 
111 #endif
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light....
Definition: gz/sim/Entity.hh:58
Abstract interface to define how the environment should handle communication simulation....
Definition: gz/sim/comms/ICommsModel.hh:67
This library is part of the Gazebo project.
The EntityComponentManager constructs, deletes, and returns components and entities....
Definition: gz/sim/EntityComponentManager.hh:66
STL class.
The EventManager is used to send/receive notifications of simulator events.
Definition: gz/sim/EventManager.hh:54
Information passed to systems on the update callback.
Definition: include/gz/sim/Types.hh:38
void Load(const Entity &_entity, std::shared_ptr< const sdf::Element > _sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) override
This method is called when the system is being configured override this to load any additional params...
A comms model that simulates communication using radio frequency (RF) devices. The model uses a log-d...
Definition: RFComms.hh:82
~RFComms() override=default
Destructor.
void Step(const ignition::gazebo::UpdateInfo &_info, const comms::Registry &_currentRegistry, comms::Registry &_newRegistry, EntityComponentManager &_ecm) override
This method is called when there is a timestep in the simulator override this to update your data str...