Mapper  0.9.0
API documentation
Public Member Functions | List of all members
OpenOrienteering::OgrFileImportFormat Class Reference

A FileFormat for geospatial vector data supported by OGR. More...

#include <ogr_file_format_public.h>

Inheritance diagram for OpenOrienteering::OgrFileImportFormat:
Inheritance graph
[legend]
Collaboration diagram for OpenOrienteering::OgrFileImportFormat:
Collaboration graph
[legend]

Public Member Functions

 OgrFileImportFormat ()
 Constructs a new OgrFileImportFormat. More...
 
std::unique_ptr< ImportermakeImporter (const QString &path, Map *map, MapView *view) const override
 Creates an importer for files supported by OGR. More...
 
 OgrFileImportFormat ()
 Constructs a new OgrFileImportFormat. More...
 
std::unique_ptr< ImportermakeImporter (const QString &path, Map *map, MapView *view) const override
 Creates an importer for files supported by OGR. 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...
 
FileFormatoperator= (const FileFormat &)=delete
 
FileFormatoperator= (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 QStringdescription () const
 Returns a short human-readable description of the file format. More...
 
const QStringprimaryExtension () const
 Returns the primary file name extension used by this file format. More...
 
const QStringListfileExtensions () const
 Returns all file name extension supported by this file format. More...
 
const QStringfilter () 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...
 
virtual ImportSupportAssumption understands (const char *buffer, int size) const
 Determines whether this FileFormat is capable of understanding a file which starts with the given byte sequence. More...
 
virtual std::unique_ptr< ExportermakeExporter (const QString &path, const Map *map, const MapView *view) const
 Creates an Exporter that will save a map to the given path. 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

A FileFormat for geospatial vector data supported by OGR.

Geospatial vector data cannot be loaded as a regular (OpenOrienteering) Map because it has no scale. However, it typically has a spatial reference, and so it can be imported into an existing map. This is the major reason for implementing the OGR support as a FileFormat.

Constructor & Destructor Documentation

◆ OgrFileImportFormat() [1/2]

OpenOrienteering::OgrFileImportFormat::OgrFileImportFormat ( )

Constructs a new OgrFileImportFormat.

◆ OgrFileImportFormat() [2/2]

OpenOrienteering::OgrFileImportFormat::OgrFileImportFormat ( )

Constructs a new OgrFileImportFormat.

Member Function Documentation

◆ makeImporter() [1/2]

std::unique_ptr< Importer > OpenOrienteering::OgrFileImportFormat::makeImporter ( const QString path,
Map map,
MapView view 
) const
overridevirtual

Creates an importer for files supported by OGR.

Reimplemented from OpenOrienteering::FileFormat.

◆ makeImporter() [2/2]

std::unique_ptr<Importer> OpenOrienteering::OgrFileImportFormat::makeImporter ( const QString path,
Map map,
MapView view 
) const
overridevirtual

Creates an importer for files supported by OGR.

Reimplemented from OpenOrienteering::FileFormat.


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