DART  6.7.3
Resource.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_RESOURCE_HPP_
34 #define DART_COMMON_RESOURCE_HPP_
35 
36 #include <cstddef>
37 #include <memory>
38 #include <string>
39 
40 namespace dart {
41 namespace common {
42 
48 class Resource
49 {
50 public:
52  enum SeekType {
56  };
57 
58  virtual ~Resource() = default;
59 
61  virtual std::size_t getSize() = 0;
62 
65  virtual std::size_t tell() = 0;
66 
71  virtual bool seek(ptrdiff_t _offset, SeekType _origin) = 0;
72 
79  virtual std::size_t read(void *_buffer, std::size_t _size, std::size_t _count) = 0;
80 
85  virtual std::string readAll();
86 };
87 
88 using ResourcePtr = std::shared_ptr<Resource>;
89 
90 } // namespace common
91 } // namespace dart
92 
93 #endif // ifndef DART_COMMON_RESOURCE_HPP_
Resource provides file-like access to a resource loaded from URI.
Definition: Resource.hpp:49
virtual std::size_t tell()=0
Return the current value of the position indicator.
virtual std::string readAll()
Reads all data from this resource, and returns it as a string.
Definition: Resource.cpp:43
virtual std::size_t read(void *_buffer, std::size_t _size, std::size_t _count)=0
Read _count element, each of size _size, into _buffer.
SeekType
Position to seek relative to.
Definition: Resource.hpp:52
@ SEEKTYPE_END
End of file.
Definition: Resource.hpp:54
@ SEEKTYPE_SET
Begining of file.
Definition: Resource.hpp:55
@ SEEKTYPE_CUR
Current position.
Definition: Resource.hpp:53
virtual std::size_t getSize()=0
Return the size of the resource, in bytes.
virtual bool seek(ptrdiff_t _offset, SeekType _origin)=0
Set the position indicator to a new position.
virtual ~Resource()=default
std::shared_ptr< Resource > ResourcePtr
Definition: Resource.hpp:88
Definition: BulletCollisionDetector.cpp:63