Gazebo Gazebo

API Reference

6.16.0
CommsEndpoint.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_COMMSENDPOINT_HH_
18 #define IGNITION_GAZEBO_SYSTEMS_COMMSENDPOINT_HH_
19 
20 #include <memory>
21 
22 #include <gz/utils/ImplPtr.hh>
23 #include <sdf/sdf.hh>
24 #include "gz/sim/System.hh"
25 
26 namespace ignition
27 {
28 namespace gazebo
29 {
30 // Inline bracket to help doxygen filtering.
31 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
32 namespace systems
33 {
66  : public System,
67  public ISystemConfigure,
68  public ISystemPreUpdate
69  {
71  public: CommsEndpoint();
72 
74  public: ~CommsEndpoint();
75 
76  // Documentation inherited
77  public: void Configure(const Entity &_entity,
80  EventManager &_eventMgr) override;
81 
82  // Documentation inherited
83  public: void PreUpdate(
84  const ignition::gazebo::UpdateInfo &_info,
86 
88  IGN_UTILS_UNIQUE_IMPL_PTR(dataPtr)
89  };
90  }
91 }
92 }
93 }
94 
95 #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
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
void Configure(const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) override
Configure the system.
Information passed to systems on the update callback.
Definition: include/gz/sim/Types.hh:38
A system that registers in the comms broker an endpoint. You're creating an address attached to the m...
Definition: CommsEndpoint.hh:65
Interface for a system that uses the PreUpdate phase.
Definition: gz/sim/System.hh:121
Interface for a system that implements optional configuration.
Definition: gz/sim/System.hh:90
void PreUpdate(const ignition::gazebo::UpdateInfo &_info, ignition::gazebo::EntityComponentManager &_ecm) override
Base class for a System.
Definition: gz/sim/System.hh:75