API Documentation
Loading...
Searching...
No Matches
NDVArchiveManager.h
Go to the documentation of this file.
1#pragma once
2#include "DLLInfo.h"
3#include <NDEVR/FileFormat.h>
4#include <NDEVR/BinaryFile.h>
5#include <NDEVR/Translator.h>
6namespace NDEVR
7{
8 /**--------------------------------------------------------------------------------------------------
9 \brief manages file archives which are compressed ndv files merged for convenience.
10 **/
12 {
13 public:
14 /**--------------------------------------------------------------------------------------------------
15 \brief Given a series of NDV files, merges them into a single compressed file
16 **/
17 static void AddFilesToArchive(const Buffer<File>& files, BinaryFile& archive, CompressionMode mode);
18 static void AddFilesToArchive(const Buffer<File>& files, File& archive_file, CompressionMode mode);
19 static Buffer<File> PullFilesFromArchive(const File& target_parent, BinaryFile& archive);
20 static Buffer<File> PullFilesFromArchive(const File& target_parent, File archive_file);
22 };
23}
#define NDEVR_FACTORY_API
Definition DLLInfo.h:57
Logic for reading or writing to a binary file including logic for.
Definition BinaryFile.h:59
The equivelent of std::vector but with a bit more control. The basic array unit of the library.
Definition Buffer.hpp:56
Data that describes a particular file format and how to use the format with the program....
Definition FileFormat.h:43
Logic for reading or writing to a file as well as navigating filesystems.
Definition File.h:48
manages file archives which are compressed ndv files merged for convenience.
Definition NDVArchiveManager.h:12
static void AddFilesToArchive(const Buffer< File > &files, BinaryFile &archive, CompressionMode mode)
Given a series of NDV files, merges them into a single compressed file.
static Buffer< File > PullFilesFromArchive(const File &target_parent, File archive_file)
static Buffer< File > PullFilesFromArchive(const File &target_parent, BinaryFile &archive)
static FileFormat ArchiveFormat()
static void AddFilesToArchive(const Buffer< File > &files, File &archive_file, CompressionMode mode)
Definition ACIColor.h:37
CompressionMode
Logical information about the type of compression implemented or requested.
Definition Compressor.h:16