MapPackage Class

Writes data to OGC GeoPackage files.

Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CEDataSets assembly)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

public class MapPackage : ResourceObject

Remarks

The MapPackage class can write data to OGC GeoPackage files. Files in this format can be read by MapPackageDataSet.

GeoPackages are standalone files that contain one or more sets of data, prepared for specific coordinate reference systems, as well as the indexes that are necessary to quickly access the data. This makes them very easy to deploy, especially to devices where you want to avoid generating indexes due to performance reasons or battery drain.

The "Export to GeoPackage" functionality in Carmenta Explorer uses this class to generate the GeoPackages. There is a tutorial that shows you how to use this functionality.

OGC GeoPackage files use the gpgk extension. They can contain:

Tiled, multi-resolution image rasters - so called image pyramids. You use the MapPackageImagePyramidWriter to write this type of data to the GeoPackage.
Tiled coverage rasters, for example elevation data - so called coverage pyramids. You use the MapPackageCoveragePyramidWriter to write this type of data to the GeoPackage.
Vector features. You use the MapPackageVectorWriter to write this type of data to the GeoPackage.
Vector tiles in the MVT format. Writing this kind of GeoPackage is not supported.
Tiled 3D models. This is a Carmenta-specific extension. You use the MapPackageModelWriter to write this type of data to the GeoPackage.

Inheritance Hierarchy

System.Object (not available in C#)
  EngineObject
    ResourceObject
      MapPackage

Platforms

Windows, Linux, Android

MapPackage Members

The MapPackage type has the following members.

Constructors

Name	Description
MapPackage	Initializes a new instance of the MapPackage class with the given path and file name for writing to a new or existing OGC GeoPackage.

Properties

Name	Description
FileName	Gets or sets the name of the OGC GeoPackage file the MapPackage writes to.
IsDisposed	Gets a value that tells whether the current MapPackage has been disposed. Inherited from EngineObject
Name	Gets or sets the name of the MapPackage. Inherited from ResourceObject
NativeHandle	Gets the native Carmenta Engine kernel object the current MapPackage represents. Inherited from EngineObject
IUserProperties.UserProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
Clone	Creates a copy of an object. Inherited from EngineObject
Close	Closes the connection to the OGC GeoPackage file this MapPackage has written data to.
Create3DTilesModelWriter	Creates a MapPackageModelWriter to create and write 3D Tiles model data to a new table in an OGC GeoPackage file.
CreateCoveragePyramidWriter	Overloaded. Creates a MapPackageCoveragePyramidWriter to write coverage data to a new table in a OGC GeoPackage.
CreateImagePyramidWriter	Overloaded. Creates a MapPackageImagePyramidWriter to write image data to a new table in an OGC GeoPackage file.
CreateMetadataWriter	Creates a GeoPackageMetadataWriter to create and write metadata to an OGC GeoPackage file.
CreateVectorWriter	Creates a MapPackageVectorWriter to create and write vector data to a new table in an OGC GeoPackage file.
Dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
Equals	Determines whether this instance is equal to another. Inherited from EngineObject
GetDataTables	Gets information about the tables stored in the OGC GeoPackage file this MapPackage is connected to.
GetPackageMetadata	Gets all metadata entries with the `geopackage` reference scope in the OGC GeoPackage file this MapPackage is connected to.
GetTableMetadata	Gets all metadata entries with the `table` scope and with the specified table name stored in the OGC GeoPackage file this MapPackage is connected to.
RemoveDataTable	Removes a table from the OGC GeoPackage file this MapPackage is connected to.
WriteModels	Reserved for internal use.

MapPackage Class

Writes data to OGC GeoPackage files.

Namespace: Carmenta::Engine
Include: <Carmenta/Engine/DataSets.hpp>
Dynamic link library: CEDataSets.Cpp64.dll
Library: CEDataSets.Cpp64.lib

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

C++

class MapPackage : public ResourceObject

C++ Smart Pointer Declaration

typedef Ptr<MapPackage> MapPackagePtr;

Remarks

The MapPackage class can write data to OGC GeoPackage files. Files in this format can be read by MapPackageDataSet.

The "Export to GeoPackage" functionality in Carmenta Explorer uses this class to generate the GeoPackages. There is a tutorial that shows you how to use this functionality.

OGC GeoPackage files use the gpgk extension. They can contain:

Tiled, multi-resolution image rasters - so called image pyramids. You use the MapPackageImagePyramidWriter to write this type of data to the GeoPackage.
Tiled coverage rasters, for example elevation data - so called coverage pyramids. You use the MapPackageCoveragePyramidWriter to write this type of data to the GeoPackage.
Vector features. You use the MapPackageVectorWriter to write this type of data to the GeoPackage.
Vector tiles in the MVT format. Writing this kind of GeoPackage is not supported.
Tiled 3D models. This is a Carmenta-specific extension. You use the MapPackageModelWriter to write this type of data to the GeoPackage.

Inheritance Hierarchy

EngineObject
ResourceObject
MapPackage

Platforms

Windows, Linux, Android

MapPackage Members

The MapPackage type has the following members.

Constructors

Name	Description
MapPackage	Initializes a new instance of the MapPackage class with the given path and file name for writing to a new or existing OGC GeoPackage.

Properties

Name	Description
fileName	Gets or sets the name of the OGC GeoPackage file the MapPackage writes to.
name	Gets or sets the name of the MapPackage. Inherited from ResourceObject
IUserProperties::userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
close	Closes the connection to the OGC GeoPackage file this MapPackage has written data to.
create3DTilesModelWriter	Creates a MapPackageModelWriter to create and write 3D Tiles model data to a new table in an OGC GeoPackage file.
createCoveragePyramidWriter	Overloaded. Creates a MapPackageCoveragePyramidWriter to write coverage data to a new table in a OGC GeoPackage.
createImagePyramidWriter	Overloaded. Creates a MapPackageImagePyramidWriter to write image data to a new table in an OGC GeoPackage file.
createMetadataWriter	Creates a GeoPackageMetadataWriter to create and write metadata to an OGC GeoPackage file.
createVectorWriter	Creates a MapPackageVectorWriter to create and write vector data to a new table in an OGC GeoPackage file.
equals	Determines whether this instance is equal to another. Inherited from EngineObject
getDataTables	Gets information about the tables stored in the OGC GeoPackage file this MapPackage is connected to.
getPackageMetadata	Gets all metadata entries with the `geopackage` reference scope in the OGC GeoPackage file this MapPackage is connected to.
getTableMetadata	Gets all metadata entries with the `table` scope and with the specified table name stored in the OGC GeoPackage file this MapPackage is connected to.
removeDataTable	Removes a table from the OGC GeoPackage file this MapPackage is connected to.
writeModels	Reserved for internal use.

MapPackage Class

Writes data to OGC GeoPackage files.

Package: com.carmenta.engine.datasets
JAR file: CEDataSets.Java.jar

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Java

public class MapPackage extends ResourceObject

Remarks

The MapPackage class can write data to OGC GeoPackage files. Files in this format can be read by MapPackageDataSet.

The "Export to GeoPackage" functionality in Carmenta Explorer uses this class to generate the GeoPackages. There is a tutorial that shows you how to use this functionality.

OGC GeoPackage files use the gpgk extension. They can contain:

Tiled, multi-resolution image rasters - so called image pyramids. You use the MapPackageImagePyramidWriter to write this type of data to the GeoPackage.
Tiled coverage rasters, for example elevation data - so called coverage pyramids. You use the MapPackageCoveragePyramidWriter to write this type of data to the GeoPackage.
Vector features. You use the MapPackageVectorWriter to write this type of data to the GeoPackage.
Vector tiles in the MVT format. Writing this kind of GeoPackage is not supported.
Tiled 3D models. This is a Carmenta-specific extension. You use the MapPackageModelWriter to write this type of data to the GeoPackage.

Inheritance Hierarchy

System::Object (not available in Java)
  EngineObject
    ResourceObject
      MapPackage

Platforms

Windows, Linux, Android

MapPackage Members

The MapPackage type has the following members.

Constructors

Name	Description
MapPackage	Initializes a new instance of the MapPackage class with the given path and file name for writing to a new or existing OGC GeoPackage.

Properties

Name	Description
fileName	Gets or sets the name of the OGC GeoPackage file the MapPackage writes to.
isDisposed	Gets a value that tells whether the current MapPackage has been disposed. Inherited from EngineObject
name	Gets or sets the name of the MapPackage. Inherited from ResourceObject
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
close	Closes the connection to the OGC GeoPackage file this MapPackage has written data to.
create3DTilesModelWriter	Creates a MapPackageModelWriter to create and write 3D Tiles model data to a new table in an OGC GeoPackage file.
createCoveragePyramidWriter	Overloaded. Creates a MapPackageCoveragePyramidWriter to write coverage data to a new table in a OGC GeoPackage.
createImagePyramidWriter	Overloaded. Creates a MapPackageImagePyramidWriter to write image data to a new table in an OGC GeoPackage file.
createMetadataWriter	Creates a GeoPackageMetadataWriter to create and write metadata to an OGC GeoPackage file.
createVectorWriter	Creates a MapPackageVectorWriter to create and write vector data to a new table in an OGC GeoPackage file.
dispose	Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject
equals	Determines whether this instance is equal to another. Inherited from EngineObject
getDataTables	Gets information about the tables stored in the OGC GeoPackage file this MapPackage is connected to.
getPackageMetadata	Gets all metadata entries with the `geopackage` reference scope in the OGC GeoPackage file this MapPackage is connected to.
getTableMetadata	Gets all metadata entries with the `table` scope and with the specified table name stored in the OGC GeoPackage file this MapPackage is connected to.
removeDataTable	Removes a table from the OGC GeoPackage file this MapPackage is connected to.
writeModels	Reserved for internal use.

MapPackage Class

Writes data to OGC GeoPackage files.

Module: Carmenta.Engine.DataSets (in DataSets.pyd)

Thread safety: Members defined in this class are, in general, not thread-safe. Show

Syntax

Python

class MapPackage ( ResourceObject )

Remarks

The MapPackage class can write data to OGC GeoPackage files. Files in this format can be read by MapPackageDataSet.

The "Export to GeoPackage" functionality in Carmenta Explorer uses this class to generate the GeoPackages. There is a tutorial that shows you how to use this functionality.

OGC GeoPackage files use the gpgk extension. They can contain:

Tiled, multi-resolution image rasters - so called image pyramids. You use the MapPackageImagePyramidWriter to write this type of data to the GeoPackage.
Tiled coverage rasters, for example elevation data - so called coverage pyramids. You use the MapPackageCoveragePyramidWriter to write this type of data to the GeoPackage.
Vector features. You use the MapPackageVectorWriter to write this type of data to the GeoPackage.
Vector tiles in the MVT format. Writing this kind of GeoPackage is not supported.
Tiled 3D models. This is a Carmenta-specific extension. You use the MapPackageModelWriter to write this type of data to the GeoPackage.

Inheritance Hierarchy

EngineObject
ResourceObject
MapPackage

Platforms

Windows, Linux, Android

MapPackage Members

The MapPackage type has the following members.

Constructors

Name	Description
MapPackage	Initializes a new instance of the MapPackage class with the given path and file name for writing to a new or existing OGC GeoPackage.

Properties

Name	Description
fileName	Gets or sets the name of the OGC GeoPackage file the MapPackage writes to.
name	Gets or sets the name of the MapPackage. Inherited from ResourceObject
IUserProperties.userProperties	Gets the AttributeSet that contains the user properties. Inherited from IUserProperties

Methods

Name	Description
clone	Creates a copy of an object. Inherited from EngineObject
close	Closes the connection to the OGC GeoPackage file this MapPackage has written data to.
create3DTilesModelWriter	Creates a MapPackageModelWriter to create and write 3D Tiles model data to a new table in an OGC GeoPackage file.
createCoveragePyramidWriter	Overloaded. Creates a MapPackageCoveragePyramidWriter to write coverage data to a new table in a OGC GeoPackage.
createImagePyramidWriter	Overloaded. Creates a MapPackageImagePyramidWriter to write image data to a new table in an OGC GeoPackage file.
createMetadataWriter	Creates a GeoPackageMetadataWriter to create and write metadata to an OGC GeoPackage file.
createVectorWriter	Creates a MapPackageVectorWriter to create and write vector data to a new table in an OGC GeoPackage file.
equals	Determines whether this instance is equal to another. Inherited from EngineObject
getDataTables	Gets information about the tables stored in the OGC GeoPackage file this MapPackage is connected to.
getPackageMetadata	Gets all metadata entries with the `geopackage` reference scope in the OGC GeoPackage file this MapPackage is connected to.
getTableMetadata	Gets all metadata entries with the `table` scope and with the specified table name stored in the OGC GeoPackage file this MapPackage is connected to.
removeDataTable	Removes a table from the OGC GeoPackage file this MapPackage is connected to.
writeModels	Reserved for internal use.

MapPackage Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

Other Resources

MapPackage Members

MapPackage Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

Other Resources

MapPackage Members

MapPackage Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

Other Resources

MapPackage Members

MapPackage Class

In this article

Syntax

Remarks

Inheritance Hierarchy

Platforms

See Also

Reference

Other Resources

MapPackage Members