Ignition Physics

API Reference

2.0.0
World.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 
18 #ifndef IGNITION_PHYSICS_DARTSIM_WORLD_HH_
19 #define IGNITION_PHYSICS_DARTSIM_WORLD_HH_
20 
21 #include <dart/simulation/World.hpp>
22 
24 
25 namespace ignition {
26 namespace physics {
27 namespace dartsim {
28 
30 class RetrieveWorld : public virtual Feature
31 {
32  public: template <typename PolicyT, typename FeaturesT>
33  class World : public virtual Feature::World<PolicyT, FeaturesT>
34  {
36  public: dart::simulation::WorldPtr GetDartsimWorld();
37  };
38 
39  public: template <typename PolicyT>
40  class Implementation : public virtual Feature::Implementation<PolicyT>
41  {
42  public: virtual dart::simulation::WorldPtr GetDartsimWorld(
43  const Identity &_worldID) = 0;
44  };
45 };
46 
48 template <typename PolicyT, typename FeaturesT>
49 dart::simulation::WorldPtr RetrieveWorld::World<PolicyT, FeaturesT>
51 {
52  return this->template Interface<RetrieveWorld>()
53  ->GetDartsimWorld(this->identity);
54 }
55 
56 }
57 }
58 }
59 
60 #endif
This class defines the concept of a Feature. It should be inherited by classes that define some plugi...
Definition: Feature.hh:35
dart::simulation::WorldPtr GetDartsimWorld()
Get the underlying dartsim world for this World object.
Definition: World.hh:50
Identity identity
This field contains information to identify the entity.
Definition: Entity.hh:291
Placeholder class in case a Feature does not define its own World API.
Definition: Feature.hh:49