Ignition Physics

API Reference

2.0.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 
29 class ConstructEmptyWorldFeature : public virtual Feature
30 {
31  public: template <typename PolicyT, typename FeaturesT>
32  class Engine : public virtual Feature::Engine<PolicyT, FeaturesT>
33  {
34  public: using WorldPtrType = WorldPtr<PolicyT, FeaturesT>;
35 
36  public: WorldPtrType ConstructEmptyWorld(const std::string &_name);
37  };
38 
39  public: template <typename PolicyT>
40  class Implementation : public virtual Feature::Implementation<PolicyT>
41  {
42  public: virtual Identity ConstructEmptyWorld(
43  const Identity &_engineID, const std::string &_name) = 0;
44  };
45 };
46 
48 class ConstructEmptyModelFeature : public virtual Feature
49 {
50  public: template <typename PolicyT, typename FeaturesT>
51  class World : public virtual Feature::World<PolicyT, FeaturesT>
52  {
53  public: using ModelPtrType = ModelPtr<PolicyT, FeaturesT>;
54 
55  public: ModelPtrType ConstructEmptyModel(const std::string &_name);
56  };
57 
58  public: template <typename PolicyT>
59  class Implementation : public virtual Feature::Implementation<PolicyT>
60  {
61  public: virtual Identity ConstructEmptyModel(
62  const Identity &_worldID, const std::string &_name) = 0;
63  };
64 };
65 
67 class ConstructEmptyLinkFeature : public virtual Feature
68 {
69  public: template <typename PolicyT, typename FeaturesT>
70  class Model : public virtual Feature::Model<PolicyT, FeaturesT>
71  {
72  public: using LinkPtrType = LinkPtr<PolicyT, FeaturesT>;
73 
74  public: LinkPtrType ConstructEmptyLink(const std::string &_name);
75  };
76 
77  public: template <typename PolicyT>
78  class Implementation : public virtual Feature::Implementation<PolicyT>
79  {
80  public: virtual Identity ConstructEmptyLink(
81  const Identity &_modelID, const std::string &_name) = 0;
82  };
83 };
84 
85 }
86 }
87 
88 #include <ignition/physics/detail/ConstructEmpty.hh>
89 
90 #endif
Definition: ConstructEmpty.hh:48
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)
STL class.
Definition: ConstructEmpty.hh:67
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:72
WorldPtr< PolicyT, FeaturesT > WorldPtrType
Definition: ConstructEmpty.hh:34
ModelPtr< PolicyT, FeaturesT > ModelPtrType
Definition: ConstructEmpty.hh:53
Definition: ConstructEmpty.hh:29