Class SBIFileExporter#

This class is the base class for exporters. More...

#include <SBIFileExporter.hpp>

Public Functions#

Type	Name
virtual bool	exportToFile (const SBNodeIndexer & nodeIndexer, const std::string & fileName, const SBValueMap & parameterMap=SBValueMap{}) = 0 Exports data from `nodeIndexer` in a file`fileName` with the given`parameters` .
virtual std::string	getExtension () const Returns the extension, e.g. "pdb".
virtual std::string	getFilter () const Returns the filter, e.g. "Protein Data Bank (.pdb)" (Qt format)*
SBGFileExporter *	getPropertyDialog () const Returns the property dialog of the exporter.
void	setPropertyDialog (SBGFileExporter * g) Sets the property dialog of the exporter.
virtual	~SBIFileExporter () Destroys the SBIFileExporter instance.

Protected Attributes#

Type	Name
SBGFileExporter *	propertyDialog

Protected Functions#

Type	Name
	SBIFileExporter () Constructs a new SBIFileExporter instance.

Detailed Description#

Short name: SBExporter

Public Functions Documentation#

function exportToFile#

Exports data from nodeIndexer in a filefileName with the givenparameters .

virtual bool SBIFileExporter::exportToFile (
    const SBNodeIndexer & nodeIndexer,
    const std::string & fileName,
    const SBValueMap & parameterMap=SBValueMap {}
) = 0

function getExtension#

Returns the extension, e.g. "pdb".

virtual std::string SBIFileExporter::getExtension () const

Returns the default file extension for the exporter.

Returns:

The file extension string.

function getFilter#

Returns the filter, e.g. "Protein Data Bank (*.pdb)" (Qt format)

virtual std::string SBIFileExporter::getFilter () const

Returns the file filter string for the exporter.

Returns:

The filter string.

function getPropertyDialog#

Returns the property dialog of the exporter.

SBGFileExporter * SBIFileExporter::getPropertyDialog () const

Returns the property dialog associated with the exporter.

Returns:

Pointer to the property dialog, or nullptr if none is set.

function setPropertyDialog#

Sets the property dialog of the exporter.

void SBIFileExporter::setPropertyDialog (
    SBGFileExporter * g
)

Parameters:

g Pointer to the property dialog to associate with this exporter.

function ~SBIFileExporter#

Destroys the SBIFileExporter instance.

virtual SBIFileExporter::~SBIFileExporter ()

Protected Attributes Documentation#

variable propertyDialog#

SBGFileExporter* SBIFileExporter::propertyDialog;

Protected Functions Documentation#

function SBIFileExporter#

Constructs a new SBIFileExporter instance.

SBIFileExporter::SBIFileExporter ()