MapGuide RFC 110 - Profiling API enhancement

This page contains a change request (RFC) for the MapGuide Open Source project. More MapGuide RFCs can be found on the RFCs page.

Status

RFC Template Version	(1.0)
Submission Date	February 23,2011
Last Modified	Bruce Dechant, February 23,2011
Author	Bruce Dechant
RFC Status	draft
Implementation Status	(pending)
Proposed Milestone	2.3
Assigned PSC guide(s)	Bruce Dechant
Voting History
+1
+0
-0
-1
no vote

Overview

This RFC adds some profiling APIs to MapGuide to help identify resources that need to be optimized and performance bottlenecks.

Motivation

Provide some profiling APIs that would generate an XML report that could be analyzed to help determine if any resources need to be optimied or if there are performance bottlenecks in the code that need to be looked at.

Proposed Solution

The following NEW APIs will be added to the offical API (PHP, Java and .Net):

MgByteReader* ProfileRenderMap(
    MgMap* map,
    MgSelection* selection,
    MgCoordinate* center,
    double scale,
    INT32 width,
    INT32 height,
    MgColor* backgroundColor,
    CREFSTRING format,
    bool bKeepSelection);

MgByteReader* ProfileRenderDynamicOverlay(
        MgMap* map,
        MgSelection* selection,
        MgRenderingOptions* options);

MgByteReader* ProfileRenderMapLegend(
    MgMap* map,
    INT32 width,
    INT32 height,
    MgColor* backgroundColor,
    CREFSTRING format);

Parameters:

MgByteReader* ProfileResource(MgResourceIdentifier* resource)

Note: The results of the ProfileResource() API depend on the type of resource profiled.

Information gathered:

MapDefinition:

LayerDefinition:

FeatureSource:

The above APIs will generate an XML document that contains the gathered profiling information.

• TBD XML document schema

Implications

None as these are new APIs.

Test Plan

Build/Run on Windows/Linux

Funding / Resources

Supplied by Autodesk