OmniPvdReadStream
Defined in pvdruntime/include/OmniPvdReadStream.h
Inheritance Relationships
Derived Type
public OmniPvdFileReadStream
(OmniPvdFileReadStream)
-
class OmniPvdReadStream
Used to abstract a memory read stream.
Allows to read and skip bytes as well as open/close it.
Subclassed by OmniPvdFileReadStream
Public Functions
-
inline virtual ~OmniPvdReadStream()
-
virtual uint64_t readBytes(uint8_t *bytes, const uint64_t nbrBytes) = 0
Read n bytes from the shared memory buffer.
- Parameters
bytes – Reads n bytes into the destination pointer
nbrBytes – The requested number of bytes to read
- Returns
The actual number of bytes read
-
virtual uint64_t skipBytes(const uint64_t nbrBytes) = 0
Skip n bytes from the shared memory buffer.
- Parameters
nbrBytes – The requested number of bytes to skip
- Returns
The actual number of bytes skipped
-
virtual bool openStream() = 0
Opens the read stream.
- Returns
True if it succeeded
-
virtual bool closeStream() = 0
Closes the read stream.
- Returns
True if it succeeded
-
inline virtual ~OmniPvdReadStream()