Referenced File Extension Interpreter to hold a collection of file paths. This class is ables to read and write the collection of file paths as data content to a Reader extensions.
More...
#include <file_extensions.h>
|
static constexpr const char *const | referenced_files_id = "referencedfiles" |
| Id for the extension.
|
|
Referenced File Extension Interpreter to hold a collection of file paths. This class is ables to read and write the collection of file paths as data content to a Reader extensions.
◆ ReferencedFilesExtension() [1/4]
move CTOR
- Parameters
-
other | the extension to move |
◆ ReferencedFilesExtension() [2/4]
adtf_file::ReferencedFilesExtension::ReferencedFilesExtension |
( |
const Reader & |
reader | ) |
|
CTOR to directly read the extension from a Reader.
- Parameters
-
reader | the reader instance to read the referenced file extension from |
◆ ReferencedFilesExtension() [3/4]
adtf_file::ReferencedFilesExtension::ReferencedFilesExtension |
( |
const std::vector< Extension > & |
extensions | ) |
|
CTOR to directly read the extension from a Extension vector.
- Parameters
-
extensions | the extension vector |
◆ ReferencedFilesExtension() [4/4]
adtf_file::ReferencedFilesExtension::ReferencedFilesExtension |
( |
const std::vector< a_util::filesystem::Path > & |
files | ) |
|
CTOR initializer to set the files for referenced files.
- Parameters
-
files | the vector of referenced files |
◆ change()
void adtf_file::ReferencedFilesExtension::change |
( |
a_util::filesystem::Path |
filename | ) |
const |
exchange the extension of a existing file ( filename
) with the current content of this ReferencedFilesExtension
- Parameters
-
filename | the file to change |
- Exceptions
-
std::invalid_argument,std::runtime_error,exceptions::ErrorFileAccess | |
◆ getFiles()
std::vector<a_util::filesystem::Path> adtf_file::ReferencedFilesExtension::getFiles |
( |
| ) |
const |
|
inline |
Get the collection of referenced files.
- Returns
- std::vector<a_util::filesystem::Path>
◆ operator=()
move Assignment
- Parameters
-
other | the extension to move |
- Returns
- *this
◆ read() [1/2]
void adtf_file::ReferencedFilesExtension::read |
( |
const Reader & |
reader | ) |
|
read the extension from a Reader
- Parameters
-
reader | the reader instance to read the referenced file extension from |
◆ read() [2/2]
void adtf_file::ReferencedFilesExtension::read |
( |
const std::vector< Extension > & |
extensions | ) |
|
read the extension from a Extension vector
- Parameters
-
extensions | the extension vector |
◆ setFiles()
void adtf_file::ReferencedFilesExtension::setFiles |
( |
const std::vector< a_util::filesystem::Path > & |
files | ) |
|
|
inline |
Set the collection of referenced files.
- Parameters
-
◆ write()
writes the extension to a Reader
- Parameters
-
writer | the reader instance to write the referenced file extension to |
The documentation for this class was generated from the following file: