You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

92 lines
2.2 KiB
C++

/*=========================================================================
Program: Visualization Toolkit
Module: vtkArchiver.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkArchiver
* @brief Writes an archive
*
* vtkArchiver is a base class for constructing an archive. The default
* implementation constructs a directory at the location of the ArchiveName
* and populates it with files and directories as requested by Insert().
* Classes that derive from vtkArchiver can customize the output using such
* features as compression, in-memory serialization and third-party archival
* tools.
*/
#ifndef vtkArchiver_h
#define vtkArchiver_h
#include "vtkCommonCoreModule.h" // For export macro
#include "vtkObject.h"
#include <ios> // For std::streamsize
class VTKCOMMONCORE_EXPORT vtkArchiver : public vtkObject
{
public:
static vtkArchiver* New();
vtkTypeMacro(vtkArchiver, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
//@{
/**
* Specify the name of the archive to generate.
*/
vtkGetStringMacro(ArchiveName);
vtkSetStringMacro(ArchiveName);
//@}
//@{
/**
* Open the arhive for writing.
*/
virtual void OpenArchive();
//@}
//@{
/**
* Close the arhive.
*/
virtual void CloseArchive();
//@}
//@{
/**
* Insert \p data of size \p size into the archive at \p relativePath.
*/
virtual void InsertIntoArchive(
const std::string& relativePath, const char* data, std::size_t size);
//@}
//@{
/**
* Checks if \p relativePath represents an entry in the archive.
*/
virtual bool Contains(const std::string& relativePath);
//@}
protected:
vtkArchiver();
~vtkArchiver() override;
char* ArchiveName;
private:
vtkArchiver(const vtkArchiver&) = delete;
void operator=(const vtkArchiver&) = delete;
};
#endif