NDEVR
API Documentation
NDVArchiveManager
Hardware and IO » IO Factories

Manages file archives which are compressed NDV files merged for convenience. More...

Static Public Member Functions

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 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.
static FileFormat ArchiveFormat ()
 Returns the FileFormat descriptor for the NDV archive format.
static Buffer< File > PullFilesFromArchive (const File &target_parent, BinaryFile &archive)
 Extracts files from an archive read through a BinaryFile stream.
static Buffer< File > PullFilesFromArchive (const File &target_parent, File archive_file)
 Extracts files from an archive file on disk.

Detailed Description

Manages file archives which are compressed NDV files merged for convenience.

Provides static utility methods for creating and extracting NDV archive files, which bundle multiple NDV files into a single compressed archive.

Definition at line 15 of file NDVArchiveManager.h.

Member Function Documentation

◆ AddFilesToArchive() [1/2]

void NDVArchiveManager::AddFilesToArchive ( const Buffer< File > & files,
BinaryFile & archive,
CompressionMode mode )
static

Given a series of NDV files, merges them into a single compressed file.

Parameters
[in]filesThe collection of files to add to the archive.
[in]archiveThe binary file stream to write the archive data into.
[in]modeThe compression mode to use when archiving.

◆ AddFilesToArchive() [2/2]

void NDVArchiveManager::AddFilesToArchive ( const Buffer< File > & files,
File & archive_file,
CompressionMode mode )
static

Given a series of NDV files, merges them into a single compressed archive file on disk.

Parameters
[in]filesThe collection of files to add to the archive.
[in]archive_fileThe destination file on disk to write the archive to.
[in]modeThe compression mode to use when archiving.

◆ ArchiveFormat()

FileFormat NDVArchiveManager::ArchiveFormat ( )
static

Returns the FileFormat descriptor for the NDV archive format.

Returns
The FileFormat representing the NDV archive type.

◆ PullFilesFromArchive() [1/2]

Buffer< File > NDVArchiveManager::PullFilesFromArchive ( const File & target_parent,
BinaryFile & archive )
static

Extracts files from an archive read through a BinaryFile stream.

Parameters
[in]target_parentThe parent directory where extracted files will be placed.
[in]archiveThe binary file stream to read the archive data from.
Returns
A buffer of extracted files.

◆ PullFilesFromArchive() [2/2]

Buffer< File > NDVArchiveManager::PullFilesFromArchive ( const File & target_parent,
File archive_file )
static

Extracts files from an archive file on disk.

Parameters
[in]target_parentThe parent directory where extracted files will be placed.
[in]archive_fileThe archive file on disk to extract from.
Returns
A buffer of extracted files.
The documentation for this class was generated from the following file: