DART  6.7.3
DartResourceRetriever.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2019, The DART development contributors
3  * All rights reserved.
4  *
5  * The list of contributors can be found at:
6  * https://github.com/dartsim/dart/blob/master/LICENSE
7  *
8  * This file is provided under the following "BSD-style" License:
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
19  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
20  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
26  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef DART_UTILS_DARTRESOURCERETRIEVER_HPP_
34 #define DART_UTILS_DARTRESOURCERETRIEVER_HPP_
35 
36 #include <unordered_map>
37 #include <vector>
39 
40 namespace dart {
41 namespace utils {
42 
64 {
65 public:
66  template <typename... Args>
67  static std::shared_ptr<DartResourceRetriever> create(Args&&... args)
68  {
69  return std::make_shared<DartResourceRetriever>(
70  std::forward<Args>(args)...);
71  }
72 
75 
77  ~DartResourceRetriever() override = default;
78 
79  // Documentation inherited.
80  bool exists(const common::Uri& uri) override;
81 
82  // Documentation inherited.
83  common::ResourcePtr retrieve(const common::Uri& uri) override;
84 
85  // Documentation inherited.
86  std::string getFilePath(const common::Uri& uri) override;
87 
88 private:
89 
90  void addDataDirectory(const std::string& packageDirectory);
91 
92  bool resolveDataUri(const common::Uri& uri, std::string& relativePath) const;
93 
94 private:
96 
97  std::vector<std::string> mDataDirectories;
98 };
99 
100 using DartResourceRetrieverPtr = std::shared_ptr<DartResourceRetriever>;
101 
102 } // namespace utils
103 } // namespace dart
104 
105 #endif // ifndef DART_UTILS_DARTRESOURCERETRIEVER_HPP_
ResourceRetriever provides methods for testing for the existance of and accessing the content of a re...
Definition: ResourceRetriever.hpp:47
Retrieve local resources from sample data files given file URI.
Definition: DartResourceRetriever.hpp:64
void addDataDirectory(const std::string &packageDirectory)
Definition: DartResourceRetriever.cpp:167
bool resolveDataUri(const common::Uri &uri, std::string &relativePath) const
Definition: DartResourceRetriever.cpp:186
static std::shared_ptr< DartResourceRetriever > create(Args &&... args)
Definition: DartResourceRetriever.hpp:67
DartResourceRetriever()
Constructor.
Definition: DartResourceRetriever.cpp:46
common::ResourceRetrieverPtr mLocalRetriever
Definition: DartResourceRetriever.hpp:95
std::string getFilePath(const common::Uri &uri) override
Returns absolute file path to uri; an empty string if unavailable.
Definition: DartResourceRetriever.cpp:129
bool exists(const common::Uri &uri) override
Returns whether the resource specified by a URI exists.
Definition: DartResourceRetriever.cpp:65
common::ResourcePtr retrieve(const common::Uri &uri) override
Returns the resource specified by a URI or nullptr on failure.
Definition: DartResourceRetriever.cpp:97
std::vector< std::string > mDataDirectories
Definition: DartResourceRetriever.hpp:97
~DartResourceRetriever() override=default
Destructor.
std::shared_ptr< Resource > ResourcePtr
Definition: Resource.hpp:88
std::shared_ptr< ResourceRetriever > ResourceRetrieverPtr
Definition: ResourceRetriever.hpp:76
std::shared_ptr< DartResourceRetriever > DartResourceRetrieverPtr
Definition: DartResourceRetriever.hpp:100
Definition: BulletCollisionDetector.cpp:63
The Uri struct provides URI parsing and merging functionality based on RFC 3986.
Definition: Uri.hpp:87