Skip to main content
Version: 🚧 Nightly

Class vtkF3DArchiveReader

Definition: vtkF3DArchiveReader.h (line 25)

Read entries from a zip archive.

Provide random access to the entries of a zip archive stored in a seekable vtkResourceStream, so that readers of archive based formats can extract the files they need without unpacking the whole archive.

Inherits from:

  • vtkObject

Members​

Private attributes​

Variable Internals​

Definition: vtkF3DArchiveReader.h (line 67)

std::unique_ptr<vtkInternals> vtkF3DArchiveReader::Internals

Type: std::unique_ptr< vtkInternals >

Public static functions​

Function New​

static vtkF3DArchiveReader * vtkF3DArchiveReader::New()

Return type: vtkF3DArchiveReader *

Public functions​

Function vtkTypeMacro​

vtkF3DArchiveReader::vtkTypeMacro(vtkF3DArchiveReader, vtkObject)

Parameters:

Return type:

Function PrintSelf​

void vtkF3DArchiveReader::PrintSelf(ostream &os, vtkIndent indent) override

Parameters:

  • ostream & os
  • vtkIndent indent

Return type: void

Function Open​

bool vtkF3DArchiveReader::Open(vtkResourceStream *stream)

Open the zip archive contained in the provided stream and read its index. The stream must support seeking and is kept referenced until the archive is closed or this reader is destroyed. Return false if the stream is not seekable or does not contain a valid archive.

Parameters:

  • vtkResourceStream * stream

Return type: bool

Function Close​

void vtkF3DArchiveReader::Close()

Close the currently opened archive, if any, and release the stream.

Return type: void

Function Has​

bool vtkF3DArchiveReader::Has(const std::string &name)

Return true if an entry with the provided name exists in the opened archive. Names are the full paths of the entries, eg: "dir/file.txt".

Parameters:

  • const std::string & name

Return type: bool

Function Extract​

bool vtkF3DArchiveReader::Extract(const std::string &name, std::vector< char > &out)

Extract the uncompressed content of the named entry into out. Return false if the archive is not opened, if the entry does not exist or if its content cannot be extracted.

Parameters:

  • const std::string & name
  • std::vector< char > & out

Return type: bool

Protected functions​

Function vtkF3DArchiveReader​

vtkF3DArchiveReader::vtkF3DArchiveReader()

Return type:

Function ~vtkF3DArchiveReader​

vtkF3DArchiveReader::~vtkF3DArchiveReader() override

Return type:

Private functions​

Function vtkF3DArchiveReader​

vtkF3DArchiveReader::vtkF3DArchiveReader(const vtkF3DArchiveReader &)=delete

Parameters:

Return type:

Function operator=​

void vtkF3DArchiveReader::operator=(const vtkF3DArchiveReader &)=delete

Parameters:

Return type: void