Maria GDK 5.0.0.753
Documentation of managed code in develop branch
Loading...
Searching...
No Matches
TPG.GDK.Windows.MapServiceInterfaces.MapPreparation Namespace Reference

Classes

class  Condition
 The condition that decides when this script should be used. More...
 
class  ConditionDescriptor
 Describes how conditions relates. More...
 
class  DataPreparationJob
 Parameters needed for a data preparation job. More...
 
class  DataPreparationProgress
 Information on progress of a current running job. More...
 
class  DiskSpaceResult
 Holds the result of a free disk space request. More...
 
class  FinishedMapInfo
 Information on the map resuling from a map preparation process . More...
 
class  GenericResult
 Generic result of a preparation job. More...
 
class  GetScriptsProgress
 Information on progress of a current running job. More...
 
interface  IMariaMapPreparationService
 Interface for service that offers preparation and deployment of map data to map services. More...
 
interface  IMariaMapPreparationServiceInformation
 Contains information generated when using the service. More...
 
class  JobErrorInfomation
 Encapsulate a single error occured when executing a job. More...
 
class  JobMetaInfo
 Contains meta information on a stored job. More...
 
class  JobResult
 Holds the result of a preparation job. More...
 
class  LegalValue
 Defines a legal value of a parameter. More...
 
class  MapPreparationScript
 The definition of a script that prepares data. This can be used for serializing and deserializing preparation scripts from xml. More...
 
class  MapPreparationScriptTool
 Defines a regular script tool. More...
 
class  Parameter
 Defines a parameter that can be modified or given to the map preparation process,. More...
 
class  ResultsFrom
 Defines results from other tools. More...
 
class  Value
 Defines a value of parameter. More...
 
class  VectorDataInfoResult
 Ogr result from analyzing vector data. More...
 
class  VectorLayerInfo
 Ogr info for vector layer. More...
 

Enumerations

enum  ConditionOperators { All , Any }
 Defines allowed operators for conditions. More...
 
enum  OutputTypes {
  Undefined , M6M , VectorTiles , OriginalRaster ,
  GeoPackage , GeoPackageWithNodata , Json , RouterDb ,
  b3dm , LocationDb
}
 Output types from a map MapPreparationScript More...
 
enum  ParameterCategory { NeedsInput , OptionalInput , VtilesReport }
 Category of a given paramter. More...
 
enum  ParameterTypes {
  TrueFalse , FreeText , RestrictedList , Numeric ,
  Color , Xml
}
 Defines the types of parameters that can be used as Parameter definitions. More...
 
enum  ScriptType { DeployToService , InformationExtraction , ExportData , DeployVerifiedResults }
 Defines the types a script can be of. More...
 

Enumeration Type Documentation

◆ ConditionOperators

Defines allowed operators for conditions.

Enumerator
All 

All conditions should match.

Any 

Any of the conditions should match.

◆ OutputTypes

Output types from a map MapPreparationScript

Enumerator
Undefined 

Output type not defined.

M6M 

Vector M6M data.

VectorTiles 

Vector tiles data.

OriginalRaster 

The source raster is not changed as output.

GeoPackage 

Raster geopackage.

GeoPackageWithNodata 

Raster geopackage with a nodata transform.

Json 

Json string.

RouterDb 

Route planning database.

b3dm 

3D tiles.

LocationDb 

Location database.

◆ ParameterCategory

Category of a given paramter.

Enumerator
NeedsInput 

A hint that the user probably has to supply a value for the paramter.

OptionalInput 

Hint that user supplied value is optional for this parameter.

VtilesReport 

The supplied value describes a Vtile report.

◆ ParameterTypes

Defines the types of parameters that can be used as Parameter definitions.

Enumerator
TrueFalse 

A parameter that only have values of True or False.

FreeText 

Free text parameter. No checking is done on the parameter.

RestrictedList 

Parameter should provide a list of allowed parameters.

Numeric 

The parameter should consist of any numeric value.

Color 

A color values should be supplied to a parameter.

Xml 

Information about the tool's results is given as xml.

◆ ScriptType

Defines the types a script can be of.

Enumerator
DeployToService 

Prepare data and deploy to service.

InformationExtraction 

Will only analyze data and provide data.

ExportData 

Script will export data, but not deploy to service.

DeployVerifiedResults 

Script will deploy data that has been verified by user.