Inviwo 0.9.12-pre
Inviwo documentation
Loading...
Searching...
No Matches
inviwo::Exporter Class Referenceabstract

A base class for a Processor that might export a file. For example a CanvasProcessor. More...

#include <exporter.h>

+ Inheritance diagram for inviwo::Exporter:

Public Member Functions

virtual std::optional< std::filesystem::path > exportFile (const std::filesystem::path &path, std::string_view name, const std::vector< FileExtension > &candidateExtensions, Overwrite overwrite) const =0
 

Detailed Description

A base class for a Processor that might export a file. For example a CanvasProcessor.

Member Function Documentation

◆ exportFile()

virtual std::optional< std::filesystem::path > inviwo::Exporter::exportFile ( const std::filesystem::path & path,
std::string_view name,
const std::vector< FileExtension > & candidateExtensions,
Overwrite overwrite ) const
pure virtual

Export some content to path/name.ext where ext is the first ext on candidateExtensions that is supported.

Returns
a string to the path of the exported file, or std::nullopt if no matching extensions were found

Implemented in inviwo::CanvasProcessor, inviwo::CanvasWithPropertiesProcessor, and inviwo::DataFrameTable.


The documentation for this class was generated from the following file: