Gazebo Sim

API Reference

9.1.0
components/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#ifndef GZ_SIM_COMPONENTS_WORLD_HH_
18#define GZ_SIM_COMPONENTS_WORLD_HH_
19
20#include <sdf/World.hh>
21
22#include <istream>
23#include <ostream>
24
27#include <gz/sim/config.hh>
28
29namespace gz
30{
31namespace sim
32{
33// Inline bracket to help doxygen filtering.
34inline namespace GZ_SIM_VERSION_NAMESPACE {
35
36// The following is only needed to keep ABI compatibility
37// TODO(azeey) Remove in main
38namespace traits
39{
40template<>
41class IsOutStreamable<std::ostream, sdf::World>
42{
43 public: static constexpr bool value = false; // NOLINT
44};
45
46template<>
47class IsInStreamable<std::istream, sdf::World>
48{
49 public: static constexpr bool value = false; // NOLINT
50};
51}
52
53namespace serializers
54{
55
59template <>
61{
62 public:
63 static std::ostream &Serialize(std::ostream &_out, const sdf::World &)
64 {
65 return _out;
66 }
67
68 public:
69 static std::istream &Deserialize(std::istream &_in, sdf::World &)
70 {
71 return _in;
72 }
73};
74}
75
76namespace components
77{
80 GZ_SIM_REGISTER_COMPONENT("gz_sim_components.World", World)
81
82
84 GZ_SIM_REGISTER_COMPONENT("gz_sim_components.WorldSdf", WorldSdf)
85}
86}
87}
88}
89
90#endif