NDEVR
API Documentation
NDVArchiveManager.h
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{
15 class NDEVR_FACTORY_API NDVArchiveManager
16 {
17 public:
24 static void AddFilesToArchive(const Buffer<File>& files, BinaryFile& archive, CompressionMode mode);
31 static void AddFilesToArchive(const Buffer<File>& files, File& archive_file, CompressionMode mode);
38 static Buffer<File> PullFilesFromArchive(const File& target_parent, BinaryFile& archive);
45 static Buffer<File> PullFilesFromArchive(const File& target_parent, File archive_file);
50 static FileFormat ArchiveFormat();
51 };
52}
DLLInfo.h
Provides cross-platform DLL export/import macros for the IOFactory module.
NDEVR_FACTORY_API
#define NDEVR_FACTORY_API
GCC/Clang symbol visibility — marks symbols as visible in the shared library.
Definition DLLInfo.h:92
BinaryFile
Logic for reading or writing to a binary file including logic for compressing or decompressing the fi...
Definition BinaryFile.h:136
Buffer
The equivelent of std::vector but with a bit more control.
Definition Buffer.hpp:58
FileFormat
Data that describes a particular file format and how to use the format with the program.
Definition FileFormat.h:45
File
Logic for reading or writing to a file as well as navigating filesystems or other common file operati...
Definition File.h:53
NDVArchiveManager
Manages file archives which are compressed NDV files merged for convenience.
Definition NDVArchiveManager.h:16
NDVArchiveManager::PullFilesFromArchive
static Buffer< File > PullFilesFromArchive(const File &target_parent, File archive_file)
Extracts files from an archive file on disk.
NDVArchiveManager::AddFilesToArchive
static void AddFilesToArchive(const Buffer< File > &files, File &archive_file, CompressionMode mode)
Given a series of NDV files, merges them into a single compressed archive file on disk.
NDVArchiveManager::AddFilesToArchive
static void AddFilesToArchive(const Buffer< File > &files, BinaryFile &archive, CompressionMode mode)
Given a series of NDV files, merges them into a single compressed file.
NDVArchiveManager::ArchiveFormat
static FileFormat ArchiveFormat()
Returns the FileFormat descriptor for the NDV archive format.
NDVArchiveManager::PullFilesFromArchive
static Buffer< File > PullFilesFromArchive(const File &target_parent, BinaryFile &archive)
Extracts files from an archive read through a BinaryFile stream.
NDEVR
The primary namespace for the NDEVR SDK.
Definition ArialTileFetcherModule.h:35
CompressionMode
CompressionMode
Forward declaration of the Module struct for module metadata.
Definition Compressor.h:17