Link.hh
Go to the documentation of this file.
1 /*
2  * Copyright 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 SDF_LINK_HH_
18 #define SDF_LINK_HH_
19 
20 #include <memory>
21 #include <string>
22 #include <ignition/math/Pose3.hh>
23 #include "sdf/Element.hh"
24 #include "sdf/SemanticPose.hh"
25 #include "sdf/Types.hh"
26 #include "sdf/sdf_config.h"
27 #include "sdf/system_util.hh"
28 
29 namespace sdf
30 {
31  // Inline bracket to help doxygen filtering.
32  inline namespace SDF_VERSION_NAMESPACE {
33  //
34 
35  // Forward declarations.
36  class Collision;
37  class Light;
38  class LinkPrivate;
39  class Sensor;
40  class Visual;
41  class LinkPrivate;
42  struct PoseRelativeToGraph;
43 
45  {
47  public: Link();
48 
51  public: Link(const Link &_link);
52 
55  public: Link(Link &&_link) noexcept;
56 
60  public: Link &operator=(Link &&_link);
61 
65  public: Link &operator=(const Link &_link);
66 
68  public: ~Link();
69 
76  public: Errors Load(ElementPtr _sdf);
77 
81  public: std::string Name() const;
82 
86  public: void SetName(const std::string &_name) const;
87 
90  public: uint64_t VisualCount() const;
91 
97  public: const Visual *VisualByIndex(const uint64_t _index) const;
98 
102  public: bool VisualNameExists(const std::string &_name) const;
103 
107  public: const Visual *VisualByName(const std::string &_name) const;
108 
111  public: uint64_t CollisionCount() const;
112 
118  public: const Collision *CollisionByIndex(const uint64_t _index) const;
119 
123  public: bool CollisionNameExists(const std::string &_name) const;
124 
128  public: const Collision *CollisionByName(const std::string &_name) const;
129 
132  public: uint64_t LightCount() const;
133 
139  public: const Light *LightByIndex(const uint64_t _index) const;
140 
144  public: bool LightNameExists(const std::string &_name) const;
145 
149  public: const Light *LightByName(const std::string &_name) const;
150 
153  public: uint64_t SensorCount() const;
154 
160  public: const Sensor *SensorByIndex(const uint64_t _index) const;
161 
165  public: bool SensorNameExists(const std::string &_name) const;
166 
172  public: const Sensor *SensorByName(const std::string &_name) const;
173 
187  public: const ignition::math::Inertiald &Inertial() const;
188 
193  public: bool SetInertial(const ignition::math::Inertiald &_inertial);
194 
199  public: const ignition::math::Pose3d &Pose() const
200  SDF_DEPRECATED(9.0);
201 
206  public: void SetPose(const ignition::math::Pose3d &_pose)
207  SDF_DEPRECATED(9.0);
208 
212  public: const ignition::math::Pose3d &RawPose() const;
213 
217  public: void SetRawPose(const ignition::math::Pose3d &_pose);
218 
223  public: const std::string &PoseRelativeTo() const;
224 
229  public: void SetPoseRelativeTo(const std::string &_frame);
230 
236  public: const std::string &PoseFrame() const
237  SDF_DEPRECATED(9.0);
238 
244  public: void SetPoseFrame(const std::string &_frame)
245  SDF_DEPRECATED(9.0);
246 
251  public: sdf::ElementPtr Element() const;
252 
256  public: sdf::SemanticPose SemanticPose() const;
257 
262  private: void SetPoseRelativeToGraph(
263  std::weak_ptr<const PoseRelativeToGraph> _graph);
264 
266  friend class Model;
267 
272  public: bool EnableWind() const;
273 
278  public: void SetEnableWind(bool _enableWind);
279 
281  private: LinkPrivate *dataPtr = nullptr;
282  };
283  }
284 }
285 #endif
Definition: Model.hh:43
class SDFORMAT_VISIBLE Element
Definition: Element.hh:49
A collision element descibes the collision properties associated with a link.
Definition: Collision.hh:44
Definition: Visual.hh:45
std::shared_ptr< Element > ElementPtr
Definition: Element.hh:53
std::vector< Error > Errors
A vector of Error.
Definition: Types.hh:89
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:48
Provides a description of a light source.
Definition: Light.hh:62
SemanticPose is a data structure that can be used by different DOM objects to resolve poses on a Pose...
Definition: SemanticPose.hh:53
namespace for Simulation Description Format parser
Definition: Actor.hh:32
#define SDF_DEPRECATED(version)
Definition: Types.hh:38