File: vtkPartitionedArchiver.h

package info (click to toggle)
paraview 5.11.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 497,236 kB
  • sloc: cpp: 3,171,290; ansic: 1,315,072; python: 134,290; xml: 103,324; sql: 65,887; sh: 5,286; javascript: 4,901; yacc: 4,383; java: 3,977; perl: 2,363; lex: 1,909; f90: 1,255; objc: 143; makefile: 119; tcl: 59; pascal: 50; fortran: 29
file content (119 lines) | stat: -rw-r--r-- 2,714 bytes parent folder | download
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkPartitionedArchiver.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   vtkPartitionedArchiver
 * @brief   Writes an archive to several buffers
 *
 * vtkPartitionedArchiver is a specialized archiver for writing datasets into
 * several memory buffers with zip compression. Each insertion into the archiver
 * is assigned to its own buffer.
 *
 * @sa
 * vtkArchiver
 */

#ifndef vtkPartitionedArchiver_h
#define vtkPartitionedArchiver_h

#include "vtkCommonArchiveModule.h" // For export macro

#include "vtkArchiver.h"

VTK_ABI_NAMESPACE_BEGIN
class VTKCOMMONARCHIVE_EXPORT vtkPartitionedArchiver : public vtkArchiver
{
public:
  static vtkPartitionedArchiver* New();
  vtkTypeMacro(vtkPartitionedArchiver, vtkArchiver);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  ///@{
  /**
   * Open the archive for writing.
   */
  void OpenArchive() override;
  ///@}

  ///@{
  /**
   * Close the archive.
   */
  void CloseArchive() override;
  ///@}

  ///@{
  /**
   * Insert \p data of size \p size into the archive at \p relativePath.
   */
  void InsertIntoArchive(
    const std::string& relativePath, const char* data, std::size_t size) override;
  ///@}

  ///@{
  /**
   * Checks if \p relativePath represents an entry in the archive.
   */
  bool Contains(const std::string& relativePath) override;
  ///@}

  ///@{
  /**
   * Access the buffer.
   */
  const char* GetBuffer(const char* relativePath);
  ///@}

  ///@{
  /**
   * Access the address of the buffer.
   */
  const void* GetBufferAddress(const char* relativePath);
  ///@}

  ///@{
  /**
   * Get the buffer used size.
   */
  std::size_t GetBufferSize(const char* relativePath);
  ///@}

  ///@{
  /**
   * Get the number of buffers in the archive.
   */
  std::size_t GetNumberOfBuffers();
  ///@}

  ///@{
  /**
   * Get the name of buffer \p i.
   */
  const char* GetBufferName(std::size_t i);
  ///@}

protected:
  vtkPartitionedArchiver();
  ~vtkPartitionedArchiver() override;

  struct Internal;
  Internal* Internals;

private:
  vtkPartitionedArchiver(const vtkPartitionedArchiver&) = delete;
  void operator=(const vtkPartitionedArchiver&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif