forked from Kitware/VTK
-
Notifications
You must be signed in to change notification settings - Fork 0
/
vtkArchiver.h
91 lines (73 loc) · 2.21 KB
/
vtkArchiver.h
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
82
83
84
85
86
87
88
89
90
91
/*=========================================================================
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