Ignition Gazebo

API Reference

6.0.0~pre1
Entity.hh
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2018 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_ENTITY_HH_
18 #define IGNITION_GAZEBO_ENTITY_HH_
19 
20 #include <cstdint>
21 #include <ignition/gazebo/config.hh>
22 #include <ignition/gazebo/Export.hh>
23 
26 namespace ignition
27 {
30  namespace gazebo
31  {
32  // Inline bracket to help doxygen filtering.
33  inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
34  // Adding component namespace information here because there is
35  // currently no one component class that seems like a good place to hold
36  // this documentation.
44  namespace components {}
45 
59  using Entity = uint64_t;
60 
62  const Entity kNullEntity{0};
63  }
64  }
65 }
66 #endif
const Entity kNullEntity
Indicates a non-existant or invalid Entity.
Definition: Entity.hh:62
This library is part of the Ignition Robotics project.
uint64_t Entity
An Entity identifies a single object in simulation such as a model, link, or light. At its core, an Entity is just an identifier.
Definition: Entity.hh:59