Interface for dealing with XML files of maps. More...

#include <xml_file_format.h>

Inheritance diagram for OpenOrienteering::XMLFileFormat:

Collaboration diagram for OpenOrienteering::XMLFileFormat:

Public Member Functions
	XMLFileFormat ()
	Creates a new file format of type XML. More...

ImportSupportAssumption	understands (const char *buffer, int size) const override
	Returns true for an XML file using the Mapper namespace. More...

std::unique_ptr< Importer >	makeImporter (const QString &path, Map map, MapView view) const override
	Creates an importer for XML files. More...

std::unique_ptr< Exporter >	makeExporter (const QString &path, const Map map, const MapView view) const override
	Creates an exporter for XML files. More...

Public Member Functions inherited from OpenOrienteering::FileFormat
	FileFormat (FileType file_type, const char *id, const QString &description, const QString &file_extension, Features features)
	Creates a new file format with the given parameters. More...

	FileFormat (const FileFormat &)=delete

	FileFormat (FileFormat &&)=delete

virtual	~FileFormat ()
	Destroys the file format information. More...

FileFormat &	operator= (const FileFormat &)=delete

FileFormat &	operator= (FileFormat &&)=delete

void	addExtension (const QString &file_extension)
	Registers an alternative file name extension. More...

FileType	fileType () const
	Returns the type of file. More...

const char *	id () const
	Returns the internal ID of the file format. More...

const QString &	description () const
	Returns a short human-readable description of the file format. More...

const QString &	primaryExtension () const
	Returns the primary file name extension used by this file format. More...

const QStringList &	fileExtensions () const
	Returns all file name extension supported by this file format. More...

const QString &	filter () const
	Returns the filter that represents this format in file dialogs. More...

bool	supportsReading () const
	Returns true if this format supports reading a Map from a file. More...

bool	supportsWriting () const
	Returns true if this format supports writing a Map to a file. More...

bool	supportsFileOpen () const
	Returns true if this format is available for File > Open... More...

bool	supportsFileSave () const
	Returns true if this format is available for File > Save. More...

bool	supportsFileSaveAs () const
	Returns true if this format is available for File > Save as... More...

bool	supportsFileImport () const
	Returns true if this format is available for File > Import... More...

bool	supportsFileExport () const
	Returns true if this format is available for File > Export... More...

bool	isReadingLossy () const
	Returns true if an importer for this file format is potentially lossy. More...

bool	isWritingLossy () const
	Returns true if an exporter for this file format is potentially lossy. More...

Static Public Attributes
static const int	minimum_version = 2
	The minimum XML file format version supported by this implementation. More...

static const int	current_version = 9
	The optimal XML file format version created by this implementation. More...

static int	active_version = 5
	The actual XML file format version to be written. More...

Additional Inherited Members
Public Types inherited from OpenOrienteering::FileFormat
enum	FileType { MapFile = 0x01, OgrFile = 0x02, AllFiles = MapFile, EndOfFileTypes }
	File type enumeration. More...

enum	Feature { Feature::FileOpen = 0x01, Feature::FileSave = 0x02, Feature::FileSaveAs = 0x04, Feature::FileImport = 0x08, Feature::FileExport = 0x10, Feature::ReadingLossy = 0x100, Feature::WritingLossy = 0x200 }
	A type which handles OR-combinations of file types. More...

enum	ImportSupportAssumption { NotSupported = 0, Unknown = 1, FullySupported = 2 }
	A type which handles OR-combinations of format implementation features. More...

Detailed Description

Interface for dealing with XML files of maps.

Constructor & Destructor Documentation

◆ XMLFileFormat()

OpenOrienteering::XMLFileFormat::XMLFileFormat ( )

Creates a new file format of type XML.

Member Function Documentation

◆ makeExporter()

std::unique_ptr< Exporter > OpenOrienteering::XMLFileFormat::makeExporter	(	const QString &	path,
		const Map *	map,
		const MapView *	view
	)		const

overridevirtual

Creates an exporter for XML files.

Reimplemented from OpenOrienteering::FileFormat.

◆ makeImporter()

std::unique_ptr< Importer > OpenOrienteering::XMLFileFormat::makeImporter	(	const QString &	path,
		Map *	map,
		MapView *	view
	)		const

overridevirtual

Creates an importer for XML files.

Reimplemented from OpenOrienteering::FileFormat.

◆ understands()

FileFormat::ImportSupportAssumption OpenOrienteering::XMLFileFormat::understands	(	const char *	buffer,
		int	size
	)		const

overridevirtual

Returns true for an XML file using the Mapper namespace.

Reimplemented from OpenOrienteering::FileFormat.

Member Data Documentation

◆ active_version

int XMLFileFormat::active_version = 5

static

The actual XML file format version to be written.

This value must be less than or equal to current_version.

◆ current_version

constexpr int OpenOrienteering::XMLFileFormat::current_version = 9

static

The optimal XML file format version created by this implementation.

◆ minimum_version

constexpr int OpenOrienteering::XMLFileFormat::minimum_version = 2

static

The minimum XML file format version supported by this implementation.

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

src/fileformats/xml_file_format.h (52d13fd on 3 Oct 2019)
src/fileformats/xml_file_format.cpp (52d13fd on 3 Oct 2019)
test/georef_ocd_mapping_t.cpp (381e118 on 7 Aug 2019)
test/georeferencing_t.cpp (bdd4903 on 1 Sep 2019)

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XMLFileFormat()

Member Function Documentation

◆ makeExporter()

◆ makeImporter()

◆ understands()

Member Data Documentation

◆ active_version

◆ current_version

◆ minimum_version