DART  6.7.3
LocalResourceRetriever.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_COMMON_LOCALRESOURCERETRIEVER_HPP_
34 #define DART_COMMON_LOCALRESOURCERETRIEVER_HPP_
35 
37 
38 namespace dart {
39 namespace common {
40 
44 {
45 public:
46  virtual ~LocalResourceRetriever() = default;
47 
48  // Documentation inherited.
49  bool exists(const Uri& _uri) override;
50 
51  // Documentation inherited.
52  ResourcePtr retrieve(const Uri& _uri) override;
53 
54  // Documentation inherited.
55  std::string getFilePath(const Uri& uri) override;
56 };
57 
58 using LocalResourceRetrieverPtr = std::shared_ptr<LocalResourceRetriever>;
59 
60 } // namespace common
61 } // namespace dart
62 
63 #endif // ifndef DART_COMMON_LOCALRESOURCERETRIEVER_HPP_
LocalResourceRetriever provides access to local resources specified by file:// URIs by wrapping the s...
Definition: LocalResourceRetriever.hpp:44
ResourcePtr retrieve(const Uri &_uri) override
Returns the resource specified by a URI or nullptr on failure.
Definition: LocalResourceRetriever.cpp:50
std::string getFilePath(const Uri &uri) override
Returns absolute file path to uri; an empty string if unavailable.
Definition: LocalResourceRetriever.cpp:67
bool exists(const Uri &_uri) override
Returns whether the resource specified by a URI exists.
Definition: LocalResourceRetriever.cpp:44
virtual ~LocalResourceRetriever()=default
ResourceRetriever provides methods for testing for the existance of and accessing the content of a re...
Definition: ResourceRetriever.hpp:47
std::shared_ptr< Resource > ResourcePtr
Definition: Resource.hpp:88
std::shared_ptr< LocalResourceRetriever > LocalResourceRetrieverPtr
Definition: LocalResourceRetriever.hpp:58
Definition: BulletCollisionDetector.cpp:63
The Uri struct provides URI parsing and merging functionality based on RFC 3986.
Definition: Uri.hpp:87