Gazebo Gazebo

API Reference

6.16.0
gz/sim/components/LevelEntityNames.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_GAZEBO_COMPONENTS_LEVELENTITYNAMES_HH_
18 #define GZ_GAZEBO_COMPONENTS_LEVELENTITYNAMES_HH_
19 
20 #include <iterator>
21 #include <string>
22 #include <set>
23 #include <gz/sim/config.hh>
24 #include <gz/sim/Export.hh>
25 
28 
29 namespace ignition
30 {
31 namespace gazebo
32 {
33 // Inline bracket to help doxygen filtering.
34 inline namespace IGNITION_GAZEBO_VERSION_NAMESPACE {
35 namespace serializers
36 {
38  {
43  public: static std::ostream &Serialize(std::ostream &_out,
44  const std::set<std::string> &_set)
45  {
46  // Character to separate level names. It's the "Unit separator".
47  const char sep = 31;
48 
49  for (const auto &entity : _set)
50  {
51  _out << entity << sep;
52  }
53  return _out;
54  }
55 
60  public: static std::istream &Deserialize(std::istream &_in,
62  {
63  _set.clear();
64 
65  const char sep = 31;
66  std::string level;
67  while (std::getline(_in, level, sep))
68  {
69  _set.insert(level);
70  }
71  return _in;
72  }
73  };
74 }
75 
76 namespace components
77 {
80  using LevelEntityNames =
81  Component<std::set<std::string>, class LevelEntityNamesTag,
82  serializers::LevelEntityNamesSerializer>;
83 
84  IGN_GAZEBO_REGISTER_COMPONENT("ign_gazebo_components.LevelEntityNames",
85  LevelEntityNames)
86 }
87 }
88 }
89 }
90 #endif
91 
This library is part of the Gazebo project.
STL class.
#define IGN_GAZEBO_REGISTER_COMPONENT(_compType, _classname)
Static component registration macro.
Definition: gz/sim/components/Factory.hh:509
T clear(T... args)
static std::istream & Deserialize(std::istream &_in, std::set< std::string > &_set)
Deserialization for std::set<std::string>.
Definition: gz/sim/components/LevelEntityNames.hh:60
Component< std::set< std::string >, class LevelEntityNamesTag, serializers::LevelEntityNamesSerializer > LevelEntityNames
A component that holds a list of names of entities to be loaded in a level.
Definition: gz/sim/components/LevelEntityNames.hh:82
STL class.
IGN_GAZEBO_REGISTER_COMPONENT("ign_gazebo_components.Actor", Actor) using AnimationTime
Time in seconds within animation being currently played.
Definition: gz/sim/components/LevelEntityNames.hh:37
static std::ostream & Serialize(std::ostream &_out, const std::set< std::string > &_set)
Serialization for std::set<std::string>.
Definition: gz/sim/components/LevelEntityNames.hh:43
T getline(T... args)
T insert(T... args)
STL class.