#region Disclaimer / License
// Copyright (C) 2013, Jackie Ng
// http://trac.osgeo.org/mapguide/wiki/maestro, jumpinjackie@gmail.com
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
//
#endregion Disclaimer / License
using OSGeo.MapGuide.ObjectModels.RuntimeMap;
using System;
namespace OSGeo.MapGuide.MaestroAPI.Commands
{
///
/// A command that creates a runtime map from the given Map Definition
///
public interface ICreateRuntimeMap : ICommand
{
///
/// The resource id of the Map Definition to create a Runtime Map from
///
string MapDefinition { get; set; }
///
/// The name to assign to the created runtime map. If null, then MapGuide will
/// auto-generate one based on the Map Definition ID
///
string TargetMapName { get; set; }
///
/// A bitmask specifying what pieces of information to include in the CREATERUNTIMEMAP response.
/// Use the to determine what
/// valid values you can use.
///
int RequestedFeatures { get; set; }
///
/// The number of icons to render inline (as base64 images) per scale range in each layer of the map
///
int IconsPerScaleRange { get; set; }
///
/// The icon image format (default: PNG)
///
string IconFormat { get; set; }
///
/// The width of each inline icon that will be rendered (default: 16)
///
int IconWidth { get; set; }
///
/// The height of each inline icon that will be rendered (default: 16)
///
int IconHeight { get; set; }
///
/// Executes the request and returns the structure of the created runtime map
///
/// The structure of the runtime map
IRuntimeMapInfo Execute();
}
///
/// A bitmask that defines what information to include in a CreateRuntimeMap or DescribeRuntimeMap
/// response.
///
[Flags]
public enum RuntimeMapRequestedFeatures : int
{
///
/// No features
///
None = 0,
///
/// Include layer and group structure
///
LayersAndGroups = 1,
///
/// Include inline icons for each layer. Does nothing if
/// is not included in the mask
///
Icons = 2,
///
/// Include feature source information for each layer. Does nothing if
/// is not included in the mask
///
FeatureSourceInformation = 4
}
}