The BufferedStream class is a template class that that performs a buffered read of Element_Type data from a VirtualFile. More...
#include <BufferedStream.hpp>
Inheritance diagram for vl::BufferedStream< Element_Type, Chunk_Size >:
Public Member Functions | |
| BufferedStream () | |
| void | seek (long long pos) |
| bool | readToken (Element_Type *token) |
| bool | readTextChar (Element_Type &ch) |
| void | ungetToken (const Element_Type &token) |
| bool | bufferEmpty () |
| int | fillBuffer () |
| bool | isEndOfFile () const |
| void | setInputFile (VirtualFile *file) |
| VirtualFile * | inputFile () |
| const VirtualFile * | inputFile () const |
| Public Member Functions inherited from vl::Object | |
| Object () | |
| Constructor. More... | |
| Object (const Object &other) | |
| Copy constructor: copies the name, ref count mutex and user data. More... | |
| Object & | operator= (const Object &other) |
| Copy operator: copies the object's name, ref count mutex and user data. More... | |
| const std::string & | objectName () const |
| The name of the object, by default set to the object's class name. More... | |
| void | setObjectName (const char *name) |
| The name of the object, by default set to the object's class name in debug builds. More... | |
| void | setObjectName (const std::string &name) |
| The name of the object, by default set to the object's class name in debug builds. More... | |
| void | setRefCountMutex (IMutex *mutex) |
| The mutex used to protect the reference counting of an Object across multiple threads. More... | |
| IMutex * | refCountMutex () |
| The mutex used to protect the reference counting of an Object across multiple threads. More... | |
| const IMutex * | refCountMutex () const |
| The mutex used to protect the reference counting of an Object across multiple threads. More... | |
| int | referenceCount () const |
| Returns the number of references of an object. More... | |
| void | incReference () const |
| Increments the reference count of an object. More... | |
| void | decReference () |
Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More... | |
| void | setAutomaticDelete (bool autodel_on) |
| If set to true the Object is deleted when its reference count reaches 0. More... | |
| bool | automaticDelete () const |
| If set to true the Object is deleted when its reference count reaches 0. More... | |
| template<class T > | |
| T * | as () |
| Casts an Object to the specified class. More... | |
| template<class T > | |
| const T * | as () const |
| Casts an Object to the specified class. More... | |
Protected Attributes | |
| ref< VirtualFile > | mInputFile |
| std::vector< Element_Type > | mUngetBuffer |
| std::vector< Element_Type > | mBuffer |
| int | mPtr |
| int | mSize |
| bool | mIsEndOfFile |
| Protected Attributes inherited from vl::Object | |
| std::string | mObjectName |
| IMutex * | mRefCountMutex |
| int | mReferenceCount |
| bool | mAutomaticDelete |
Additional Inherited Members | |
| Protected Member Functions inherited from vl::Object | |
| virtual | ~Object () |
Detailed Description
template<class Element_Type, int Chunk_Size>
class vl::BufferedStream< Element_Type, Chunk_Size >
The BufferedStream class is a template class that that performs a buffered read of Element_Type data from a VirtualFile.
Definition at line 49 of file BufferedStream.hpp.
Constructor & Destructor Documentation
◆ BufferedStream()
|
inline |
Definition at line 54 of file BufferedStream.hpp.
Member Function Documentation
◆ bufferEmpty()
|
inline |
Definition at line 126 of file BufferedStream.hpp.
Referenced by vl::BufferedStream< char, 128 *1024 >::readToken().
◆ fillBuffer()
|
inline |
Definition at line 131 of file BufferedStream.hpp.
Referenced by vl::BufferedStream< char, 128 *1024 >::readToken().
◆ inputFile() [1/2]
|
inline |
Definition at line 157 of file BufferedStream.hpp.
Referenced by vl::BufferedStream< char, 128 *1024 >::fillBuffer(), vl::ObjLoader::loadOBJ(), and vl::BufferedStream< char, 128 *1024 >::seek().
◆ inputFile() [2/2]
|
inline |
Definition at line 159 of file BufferedStream.hpp.
◆ isEndOfFile()
|
inline |
Definition at line 149 of file BufferedStream.hpp.
◆ readTextChar()
|
inline |
Definition at line 97 of file BufferedStream.hpp.
◆ readToken()
|
inline |
Definition at line 70 of file BufferedStream.hpp.
Referenced by vl::BufferedStream< char, 128 *1024 >::readTextChar().
◆ seek()
|
inline |
Definition at line 62 of file BufferedStream.hpp.
Referenced by vl::loadMOL2().
◆ setInputFile()
|
inline |
Definition at line 151 of file BufferedStream.hpp.
Referenced by vl::STLLoader::loadAscii(), vl::loadMOL2(), vl::PlyLoader::loadPly(), and vlX::VLXSerializer::loadVLT().
◆ ungetToken()
|
inline |
Definition at line 121 of file BufferedStream.hpp.
Referenced by vl::BufferedStream< char, 128 *1024 >::readTextChar().
Member Data Documentation
◆ mBuffer
|
protected |
Definition at line 164 of file BufferedStream.hpp.
Referenced by vl::BufferedStream< char, 128 *1024 >::BufferedStream(), vl::BufferedStream< char, 128 *1024 >::fillBuffer(), and vl::BufferedStream< char, 128 *1024 >::readToken().
◆ mInputFile
|
protected |
Definition at line 162 of file BufferedStream.hpp.
Referenced by vl::BufferedStream< char, 128 *1024 >::inputFile(), and vl::BufferedStream< char, 128 *1024 >::setInputFile().
◆ mIsEndOfFile
|
protected |
◆ mPtr
|
protected |
Definition at line 165 of file BufferedStream.hpp.
Referenced by vl::BufferedStream< char, 128 *1024 >::BufferedStream(), vl::BufferedStream< char, 128 *1024 >::bufferEmpty(), vl::BufferedStream< char, 128 *1024 >::fillBuffer(), vl::BufferedStream< char, 128 *1024 >::readToken(), and vl::BufferedStream< char, 128 *1024 >::seek().
◆ mSize
|
protected |
◆ mUngetBuffer
|
protected |
Definition at line 163 of file BufferedStream.hpp.
Referenced by vl::BufferedStream< char, 128 *1024 >::readToken(), and vl::BufferedStream< char, 128 *1024 >::ungetToken().
The documentation for this class was generated from the following file:
- C:/git/VL/src/vlCore/BufferedStream.hpp