DART  6.10.1
LocalResource.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_LOCALRESOURCE_HPP_
34 #define DART_COMMON_LOCALRESOURCE_HPP_
35 
37 #include "dart/common/Resource.hpp"
38 
39 namespace dart {
40 namespace common {
41 
43 class LocalResource : public virtual Resource
44 {
45 public:
46  explicit LocalResource(const std::string& _path);
47  virtual ~LocalResource();
48 
49  LocalResource(const LocalResource& _other) = delete;
50  LocalResource& operator=(const LocalResource& _other) = delete;
51 
53  bool isGood() const;
54 
55  // Documentation inherited.
56  std::size_t getSize() override;
57 
58  // Documentation inherited.
59  std::size_t tell() override;
60 
61  // Documentation inherited.
62  bool seek(ptrdiff_t _origin, SeekType _mode) override;
63 
64  // Documentation inherited.
65  std::size_t read(
66  void* _buffer, std::size_t _size, std::size_t _count) override;
67 
68 private:
69  std::FILE* mFile;
70 };
72 
73 } // namespace common
74 } // namespace dart
75 
76 #endif // ifndef DART_COMMON_LOCALRESOURCE_HPP_
#define DART_DECLARE_CLASS_WITH_VIRTUAL_BASE_END
Definition: ClassWithVirtualBase.hpp:44
#define DART_DECLARE_CLASS_WITH_VIRTUAL_BASE_BEGIN
Definition: ClassWithVirtualBase.hpp:43
Definition: LocalResource.hpp:44
std::FILE * mFile
Definition: LocalResource.hpp:69
bool isGood() const
Returns true if the resource is open and in a valid state.
Definition: LocalResource.cpp:67
LocalResource(const LocalResource &_other)=delete
std::size_t tell() override
Return the current value of the position indicator.
Definition: LocalResource.cpp:129
LocalResource(const std::string &_path)
Definition: LocalResource.cpp:43
virtual ~LocalResource()
Definition: LocalResource.cpp:54
std::size_t getSize() override
Return the size of the resource, in bytes.
Definition: LocalResource.cpp:73
bool seek(ptrdiff_t _origin, SeekType _mode) override
Set the position indicator to a new position.
Definition: LocalResource.cpp:157
std::size_t read(void *_buffer, std::size_t _size, std::size_t _count) override
Read _count element, each of size _size, into _buffer.
Definition: LocalResource.cpp:191
LocalResource & operator=(const LocalResource &_other)=delete
Resource provides file-like access to a resource loaded from URI.
Definition: Resource.hpp:49
SeekType
Position to seek relative to.
Definition: Resource.hpp:53
Definition: BulletCollisionDetector.cpp:65