Gazebo Msgs

API Reference

5.11.0
ignition/msgs/Filesystem.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 
18 #ifndef IGNITION_MSGS_FILESYSTEM_HH_
19 #define IGNITION_MSGS_FILESYSTEM_HH_
20 
21 #include <memory>
22 #include <string>
23 
24 #include <ignition/msgs/Export.hh>
26 
27 namespace ignition
28 {
29  namespace msgs
30  {
34  {
38 
43  };
44 
45  // /// \internal
46  class DirIterPrivate;
47 
50  class IGNITION_MSGS_VISIBLE DirIter
51  {
54  public: explicit DirIter(const std::string &_in);
55 
57  public: DirIter();
58 
61  public: std::string operator*() const;
62 
65  public: const DirIter& operator++();
66 
71  public: bool operator!=(const DirIter &_other) const;
72 
74  public: ~DirIter();
75 
77  private: void Next();
78 
80  private: void SetInternalEmpty();
81 
83  private: void CloseHandle();
84 
87  private: std::unique_ptr<DirIterPrivate> dataPtr;
89  };
90  }
91 }
92 
93 #endif
STL class.
@ FSWO_LOG_WARNINGS
Errors that occur during filesystem manipulation should be logged as warnings using ignwarn....
Definition: ignition/msgs/Filesystem.hh:37
#define IGN_MSGS_WARN_IGNORE__DLL_INTERFACE_MISSING
Microsoft Visual Studio does not automatically export the interface information for member variables ...
Definition: ignition/msgs/SuppressWarning.hh:63
#define IGN_MSGS_WARN_RESUME__DLL_INTERFACE_MISSING
Definition: ignition/msgs/SuppressWarning.hh:66
DirIter()
Constructor for end element.
bool operator!=(const DirIter &_other) const
Comparison operator to see if this iterator is at the same point as another iterator.
const DirIter & operator++()
Pre-increment operator; moves to next directory record.
@ FSWO_SUPPRESS_WARNINGS
Errors that occur during filesystem manipulation should not be logged. The user will be responsible f...
Definition: ignition/msgs/Filesystem.hh:42
FilesystemWarningOp
Options for how to handle errors that occur in functions that manipulate the filesystem.
Definition: ignition/msgs/Filesystem.hh:33
A class for iterating over all items in a directory.
Definition: ignition/msgs/Filesystem.hh:50
std::string operator*() const
Dereference operator; returns current directory record.