DART  6.10.1
ResourceRetriever.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2021, 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_COMMON_RESOURCERETRIEVER_HPP_
34 #define DART_COMMON_RESOURCERETRIEVER_HPP_
35 
36 #include <memory>
37 #include <string>
38 #include "dart/common/Resource.hpp"
39 #include "dart/common/Uri.hpp"
40 
41 namespace dart {
42 namespace common {
43 
47 {
48 public:
49  virtual ~ResourceRetriever() = default;
50 
52  virtual bool exists(const Uri& uri) = 0;
53 
55  virtual ResourcePtr retrieve(const Uri& uri) = 0;
56 
62  virtual std::string readAll(const Uri& uri);
63 
67  virtual std::string getFilePath(const Uri& uri);
68 
69  // We don't const-qualify for exists, retrieve, readAll, and getFilePath here.
70  // Derived classes of ResourceRetriever will be interacting with external
71  // resources that you don't necessarily have control over so we cannot
72  // guarantee that you get the same result every time with the same input Uri.
73  // Indeed, const-qualification for those functions is pointless.
74 };
75 
76 using ResourceRetrieverPtr = std::shared_ptr<ResourceRetriever>;
77 
78 } // namespace common
79 } // namespace dart
80 
81 #endif // ifndef DART_COMMON_RESOURCERETRIEVER_HPP_
ResourceRetriever provides methods for testing for the existance of and accessing the content of a re...
Definition: ResourceRetriever.hpp:47
virtual std::string getFilePath(const Uri &uri)
Returns absolute file path to uri; an empty string if unavailable.
Definition: ResourceRetriever.cpp:57
virtual bool exists(const Uri &uri)=0
Returns whether the resource specified by a URI exists.
virtual ResourcePtr retrieve(const Uri &uri)=0
Returns the resource specified by a URI or nullptr on failure.
virtual ~ResourceRetriever()=default
virtual std::string readAll(const Uri &uri)
Reads all data from the resource of uri, and returns it as a string.
Definition: ResourceRetriever.cpp:42
std::shared_ptr< Resource > ResourcePtr
Definition: Resource.hpp:90
std::shared_ptr< ResourceRetriever > ResourceRetrieverPtr
Definition: ResourceRetriever.hpp:76
Definition: BulletCollisionDetector.cpp:65
The Uri struct provides URI parsing and merging functionality based on RFC 3986.
Definition: Uri.hpp:87