Ignition Physics

API Reference

2.3.0
ConstructEmpty.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_CONSTRUCTEMPTY_HH_
19 #define IGNITION_PHYSICS_CONSTRUCTEMPTY_HH_
20 
21 #include <string>
22 
24 
25 namespace ignition {
26 namespace physics {
27 
31 class ConstructEmptyWorldFeature : public virtual Feature
32 {
33  public: template <typename PolicyT, typename FeaturesT>
34  class Engine : public virtual Feature::Engine<PolicyT, FeaturesT>
35  {
36  public: using WorldPtrType = WorldPtr<PolicyT, FeaturesT>;
37 
41  public: WorldPtrType ConstructEmptyWorld(const std::string &_name);
42  };
43 
44  public: template <typename PolicyT>
45  class Implementation : public virtual Feature::Implementation<PolicyT>
46  {
47  public: virtual Identity ConstructEmptyWorld(
48  const Identity &_engineID, const std::string &_name) = 0;
49  };
50 };
51 
55 class ConstructEmptyModelFeature : public virtual Feature
56 {
57  public: template <typename PolicyT, typename FeaturesT>
58  class World : public virtual Feature::World<PolicyT, FeaturesT>
59  {
60  public: using ModelPtrType = ModelPtr<PolicyT, FeaturesT>;
61 
65  public: ModelPtrType ConstructEmptyModel(const std::string &_name);
66  };
67 
68  public: template <typename PolicyT>
69  class Implementation : public virtual Feature::Implementation<PolicyT>
70  {
71  public: virtual Identity ConstructEmptyModel(
72  const Identity &_worldID, const std::string &_name) = 0;
73  };
74 };
75 
79 class ConstructEmptyLinkFeature : public virtual Feature
80 {
81  public: template <typename PolicyT, typename FeaturesT>
82  class Model : public virtual Feature::Model<PolicyT, FeaturesT>
83  {
84  public: using LinkPtrType = LinkPtr<PolicyT, FeaturesT>;
85 
89  public: LinkPtrType ConstructEmptyLink(const std::string &_name);
90  };
91 
92  public: template <typename PolicyT>
93  class Implementation : public virtual Feature::Implementation<PolicyT>
94  {
95  public: virtual Identity ConstructEmptyLink(
96  const Identity &_modelID, const std::string &_name) = 0;
97  };
98 };
99 
100 }
101 }
102 
103 #include <ignition/physics/detail/ConstructEmpty.hh>
104 
105 #endif
This feature constructs an empty model and return its pointer from the given world.
Definition: ConstructEmpty.hh:55
This class defines the concept of a Feature. It should be inherited by classes that define some plugi...
Definition: Feature.hh:35
WorldPtrType ConstructEmptyWorld(const std::string &_name)
Construct an empty world and attach a given name to it.
STL class.
This feature constructs an empty link and return its pointer from the given model.
Definition: ConstructEmpty.hh:79
Placeholder class for the Engine API. Every Engine feature MUST inherit this class.
Definition: Feature.hh:40
Placeholder class in case a Feature does not define its own World API.
Definition: Feature.hh:49
Placeholder class in case a Feature does not define its own Model API.
Definition: Feature.hh:58
LinkPtr< PolicyT, FeaturesT > LinkPtrType
Definition: ConstructEmpty.hh:84
WorldPtr< PolicyT, FeaturesT > WorldPtrType
Definition: ConstructEmpty.hh:36
ModelPtr< PolicyT, FeaturesT > ModelPtrType
Definition: ConstructEmpty.hh:60
This feature constructs an empty world and return its pointer from the current physics engine in use...
Definition: ConstructEmpty.hh:31