PIE SDK算法的自定义扩展

1.算法功能简介

算法的自定义扩展允许用户自主开发新的算法。自定义的算法必须实现PIE.SystemAlgo.BaseSystemAlgo基础类，这样才能被PIE的算法管理器调用起来。

2.算法功能实现说明

2.1. 示例简介

本算法用于实现栅格影像的拷贝。参数类“AlgoParams.cs”用于存放要拷贝的路径和拷贝到的路径，算法类“Algo.cs”用于执行算法，窗体类“FormTest.cs”用于接收用户输入的要拷贝的路径和拷贝到的路径，Command类“AlgoCommand.cs”用于实现算法调用。

算法类“Algo.cs”继承自BaseSystemAlgo,该类实现了ISystemAlgo, ISystemAlgoEvents两个接口。以下对BaseSystemAlgo类的属性，方法和事件进行介绍：

属性介绍
Description	String	描述
Name	String	名称
Params	String	参数
方法介绍
Execute()	Bool	执行算法，返回结果:是否执行成功
GetErrorInfo(ref int errCode, ref string errMsg)	Void	获取错误信息，参数: errCode:错误信息编号，errMsg:错误信息描述
事件介绍
OnExecuteCompleted	OnExecuteCompletedEventHandler	执行完成事件
OnProgressChanged	OnProgressChangedEventHandler	进度变化事件

2.2. 实现步骤

第一步	编写参数类“AlgoParams.cs”
第二步	构造算法类“Algo.cs”
第三步	新建窗体类“FormTest.cs”
第四步	写Command类实现算法调用

2.3. 示例代码

项目路径	百度云盘地址下/PIE示例程序/10.算法调用/算法的调用方式/Algo.AlgoTest
数据路径	百度云盘地址下/PIE示例数据/栅格数据/04.World/ World.tif
视频路径	百度云盘地址下/PIE视频教程/10.算法调用/算法的调用方式/算法的自定义扩展.avi
示例代码
//（一）编写参数类“AlgoParams.cs” public class AlgoParams { /// <summary> /// 要拷贝的路径 /// </summary> public string OpenFilePath; /// <summary> /// 拷贝到的路径 /// </summary> public string SaveFilePath; } //（二）构造算法类“Algo.cs” public class Algo : PIE.SystemAlgo.BaseSystemAlgo { /// <summary> /// 构造函数 /// </summary> public Algo() { } /// <summary> /// 执行算法 /// </summary> /// <returns>是否执行成功</returns> public override bool Execute() { AlgoParams m_AlgoParams = (AlgoParams)this.Params; if (string.IsNullOrEmpty(m_AlgoParams.OpenFilePath) || string.IsNullOrEmpty(m_AlgoParams.SaveFilePath)) return false; File.Copy(m_AlgoParams.OpenFilePath, m_AlgoParams.SaveFilePath, true); return true; } } //（三）新建窗体类“FormTest.cs” public partial class FormTest : Form { /// <summary> /// 算法参数 /// </summary> private AlgoTest.AlgoParams m_Parm = new AlgoParams(); /// <summary> /// 构造函数 /// </summary> public FormTest() { InitializeComponent(); } /// <summary> /// 算法参数 /// </summary> public AlgoParams Params { get { return m_Parm; } set { this.m_Parm = value; } } private void buttonEdit_save_ButtonClick(object sender, DevExpress.XtraEditors.Controls.ButtonPressedEventArgs e) { SaveFileDialog save = new SaveFileDialog(); save.Title = "另存为"; save.Filter = "Raster Files|*.tif"; save.FileName = ""; if (save.ShowDialog() == DialogResult.OK) { this.buttonEdit_save.Text = save.FileName; } } private void simpleButton_ok_Click(object sender, EventArgs e) { if (string.IsNullOrEmpty(this.buttonEdit_tif.Text) || string.IsNullOrEmpty(this.buttonEdit_save.Text)) { MessageBox.Show("请输入路径！"); return; } m_Parm.OpenFilePath = this.buttonEdit_tif.Text; m_Parm.SaveFilePath = this.buttonEdit_save.Text; this.DialogResult = DialogResult.OK; } private void simpleButton_cancel_Click(object sender, EventArgs e) { this.Close(); } private void buttonEdit_tif_ButtonClick(object sender, DevExpress.XtraEditors.Controls.ButtonPressedEventArgs e) { OpenFileDialog open = new OpenFileDialog(); open.Filter = "Raster Files|*.tif"; open.Title = "选择栅格文件"; open.Multiselect = false; if (open.ShowDialog() != DialogResult.OK) return; string filePath = open.FileName; IRasterDataset dataSet = DatasetFactory.OpenRasterDataset(filePath, OpenMode.ReadOnly); if (dataSet == null) { MessageBox.Show("文件打开失败！"); return; } if (!dataSet.Open(filePath, OpenMode.ReadOnly)) { MessageBox.Show("文件打开失败！"); return; } this.buttonEdit_tif.Text = filePath; } } //（四）写Command类实现算法调用 public class AlgoCommand: DesktopCommand { /// <summary> /// 构造函数 /// </summary> public AlgoCommand() { this.Caption = "测试算法"; this.Name = "AlgoCommand"; this.ToolTip = "测试算法"; this.Checked = false; this.Enabled = false; } /// <summary> /// 单击方法 /// </summary> public override void OnClick() { #region 1、参数设置 if (!this.Enabled) return; FormTest frmTest = new FormTest(); if (frmTest.ShowDialog() != System.Windows.Forms.DialogResult.OK) return; AlgoParams info = frmTest.Params; PIE.SystemAlgo.ISystemAlgo algo = PIE.SystemAlgo.AlgoFactory.Instance().CreateAlgo("AlgoTest.dll", "AlgoTest.Algo"); if (algo == null) return; PIE.SystemAlgo.ISystemAlgoEvents algoEvents = algo as PIE.SystemAlgo.ISystemAlgoEvents; algo.Name = "测试算法"; algo.Params = info; algoEvents.OnExecuteCompleted += OnAlgoExcuteCompleted; algoEvents.OnProgressChanged += OnAlgoProgressChanged; #endregion //2、算法执行 PIE.AxControls.IStatusBar statusBar = m_Application.StatusBar; statusBar.ShowProgress(, , ""); PIE.SystemAlgo.AlgoFactory.Instance().AsynExecuteAlgo(algo); } /// <summary> /// 算法执行完成事件 /// </summary> /// <param name="algo">算法</param> private void OnAlgoExcuteCompleted(PIE.SystemAlgo.ISystemAlgo algo) { PIE.AxControls.IStatusBar statusBar = m_Application.StatusBar; statusBar.UpdateProgress(, ""); statusBar.HideProgress(); //3、结果显示 AlgoParams info = (AlgoParams)algo.Params; PIE.Carto.ILayer layer = PIE.Carto.LayerFactory.CreateDefaultLayer(info.SaveFilePath); m_HookHelper.FocusMap.AddLayer(layer); m_HookHelper.ActiveView.PartialRefresh(PIE.Carto.ViewDrawPhaseType.ViewAll); PIE.SystemAlgo.ISystemAlgoEvents algoEvents = algo as PIE.SystemAlgo.ISystemAlgoEvents; algoEvents.OnExecuteCompleted -= OnAlgoExcuteCompleted; algoEvents.OnProgressChanged -= OnAlgoProgressChanged; } /// <summary> /// 算法进度变化事件 /// </summary> /// <param name="complete">进度</param> /// <param name="msg">进度信息</param> /// <param name="algo">算法</param> /// <returns>int</returns> private int OnAlgoProgressChanged(double complete, string msg, PIE.SystemAlgo.ISystemAlgo algo) { PIE.AxControls.IStatusBar statusBar = m_Application.StatusBar; statusBar.UpdateProgress((int)complete, msg); return ; } }

2.4. 示例截图