Gazebo Gazebo

API Reference

6.16.0
Label.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2021 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_LABEL_HH_
18 #define IGNITION_GAZEBO_SYSTEMS_LABEL_HH_
19 
20 #include <memory>
21 
22 #include "gz/sim/config.hh"
23 #include "gz/sim/System.hh"
24 
25 namespace ignition
26 {
27 namespace gazebo
28 {
29 // Inline bracket to help doxygen filtering.
30 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
31 namespace systems
32 {
39  class Label:
40  public System,
41  public ISystemConfigure
42  {
44  public: explicit Label();
45 
47  public: ~Label() override;
48 
49  // Documentation inherited
50  public: void Configure(const Entity &_entity,
53  gazebo::EventManager &_eventMgr) final;
54  };
55  }
56 }
57 }
58 }
59 #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.
A label plugin that annotates models by setting the label for the parent entity's visuals....
Definition: Label.hh:39
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, gazebo::EventManager &_eventMgr) final
Configure the system.
~Label() override
Destructor.
Interface for a system that implements optional configuration.
Definition: gz/sim/System.hh:90
Base class for a System.
Definition: gz/sim/System.hh:75