DART  6.7.3
CompositeResourceRetriever.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_COMPOSITERESOURCERETRIEVER_HPP_
34 #define DART_UTILS_COMPOSITERESOURCERETRIEVER_HPP_
35 
36 #include <unordered_map>
37 #include <vector>
39 
40 namespace dart {
41 namespace utils {
42 
48 {
49 public:
50  virtual ~CompositeResourceRetriever() = default;
51 
58  const common::ResourceRetrieverPtr& _resourceRetriever);
59 
65  bool addSchemaRetriever(
66  const std::string& _schema,
67  const common::ResourceRetrieverPtr& _resourceRetriever);
68 
69  // Documentation inherited.
70  bool exists(const common::Uri& _uri) override;
71 
72  // Documentation inherited.
73  common::ResourcePtr retrieve(const common::Uri& _uri) override;
74 
75  // Documentation inherited.
76  std::string getFilePath(const common::Uri& uri) override;
77 
78 private:
79  std::vector<common::ResourceRetrieverPtr> getRetrievers(
80  const common::Uri& _uri) const;
81 
82  std::unordered_map<std::string,
83  std::vector<common::ResourceRetrieverPtr> > mResourceRetrievers;
84  std::vector<common::ResourceRetrieverPtr> mDefaultResourceRetrievers;
85 };
86 
88  = std::shared_ptr<CompositeResourceRetriever>;
89 
90 } // namespace utils
91 } // namespace dart
92 
93 #endif // ifndef DART_UTILS_COMPOSITERESOURCERETRIEVER_HPP_
ResourceRetriever provides methods for testing for the existance of and accessing the content of a re...
Definition: ResourceRetriever.hpp:47
CompositeResourceRetriever allows multiple ResourceRetriever to be used interchangably by: (1) associ...
Definition: CompositeResourceRetriever.hpp:48
bool addSchemaRetriever(const std::string &_schema, const common::ResourceRetrieverPtr &_resourceRetriever)
Add a default ResourceRetriever for _schema This ResourceRetriever will be called after URIs that mat...
Definition: CompositeResourceRetriever.cpp:49
std::string getFilePath(const common::Uri &uri) override
Returns absolute file path to uri; an empty string if unavailable.
Definition: CompositeResourceRetriever.cpp:104
void addDefaultRetriever(const common::ResourceRetrieverPtr &_resourceRetriever)
Add a default ResourceRetriever for all URIs.
Definition: CompositeResourceRetriever.cpp:42
std::unordered_map< std::string, std::vector< common::ResourceRetrieverPtr > > mResourceRetrievers
Definition: CompositeResourceRetriever.hpp:83
std::vector< common::ResourceRetrieverPtr > mDefaultResourceRetrievers
Definition: CompositeResourceRetriever.hpp:84
bool exists(const common::Uri &_uri) override
Returns whether the resource specified by a URI exists.
Definition: CompositeResourceRetriever.cpp:73
common::ResourcePtr retrieve(const common::Uri &_uri) override
Returns the resource specified by a URI or nullptr on failure.
Definition: CompositeResourceRetriever.cpp:85
std::vector< common::ResourceRetrieverPtr > getRetrievers(const common::Uri &_uri) const
Definition: CompositeResourceRetriever.cpp:118
std::shared_ptr< Resource > ResourcePtr
Definition: Resource.hpp:88
std::shared_ptr< ResourceRetriever > ResourceRetrieverPtr
Definition: ResourceRetriever.hpp:76
std::shared_ptr< CompositeResourceRetriever > CompositeResourceRetrieverPtr
Definition: CompositeResourceRetriever.hpp:88
Definition: BulletCollisionDetector.cpp:63
The Uri struct provides URI parsing and merging functionality based on RFC 3986.
Definition: Uri.hpp:87