1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkInputStream
* @brief Wraps a binary input stream with a VTK interface.
*
* vtkInputStream provides a VTK-style interface wrapping around a
* standard input stream. The access methods are virtual so that
* subclasses can transparently provide decoding of an encoded stream.
* Data lengths for Seek and Read calls refer to the length of the
* input data. The actual length in the stream may differ for
* subclasses that implement an encoding scheme.
*/
#ifndef vtkInputStream_h
#define vtkInputStream_h
#include "vtkIOCoreModule.h" // For export macro
#include "vtkObject.h"
VTK_ABI_NAMESPACE_BEGIN
class VTKIOCORE_EXPORT vtkInputStream : public vtkObject
{
public:
vtkTypeMacro(vtkInputStream, vtkObject);
static vtkInputStream* New();
void PrintSelf(ostream& os, vtkIndent indent) override;
///@{
/**
* Get/Set the real input stream.
*/
vtkSetMacro(Stream, istream*);
vtkGetMacro(Stream, istream*);
///@}
/**
* Called after the stream position has been set by the caller, but
* before any Seek or Read calls. The stream position should not be
* adjusted by the caller until after an EndReading call.
*/
virtual void StartReading();
/**
* Seek to the given offset in the input data. Returns 1 for
* success, 0 for failure.
*/
virtual int Seek(vtkTypeInt64 offset);
/**
* Read input data of the given length. Returns amount actually
* read.
*/
virtual size_t Read(void* data, size_t length);
/**
* Called after all desired calls to Seek and Read have been made.
* After this call, the caller is free to change the position of the
* stream. Additional reads should not be done until after another
* call to StartReading.
*/
virtual void EndReading();
protected:
vtkInputStream();
~vtkInputStream() override;
// The real input stream.
istream* Stream;
size_t ReadStream(char* data, size_t length);
// The input stream's position when StartReading was called.
vtkTypeInt64 StreamStartPosition;
private:
vtkInputStream(const vtkInputStream&) = delete;
void operator=(const vtkInputStream&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|