IGPFunction2

接口

接口意义

UID DialogCLSID { get; }

对话框的类标识，该方法在实现时直接返回为空即可。

public UID DialogCLSID{ get{ return null; }}

string DisplayName { get; }

该GP工具显示的名字 显示的名字和FullName中设置的一致。

IName FullName { get; }

IGPFunctionName functionName = new GPFunctionNameClass();

functionName.MinimumProduct = esriProductCode.esriProductCodeAdvanced;

IGPName name;

name = (IGPName)functionName;

name.Category = "AreaCalculation0";//分组名称

name.Description = "Calculate Area for FeatureClass0";//GP工具的描述信息

name.DisplayName = "Calculate Area0";//GP工具显示的名称

name.Name = "CalculateArea0";//GP工具的名称

name.Factory = new 所属的工厂类//GP工具所属的工厂类

int HelpContext { get; }

帮助文件的上下文 直接返回0即可。

string HelpFile { get; }

帮助文件路径，直接返回空字符串即可。

string MetadataFile { get; }

元数据文件，返回空字符串即可。

string Name { get; }

返回GP工具的名字，名字和fullName中设置的名字一致

IArray ParameterInfo { get; }

参数列表，定义系统输入和输出的参数

//定义参数列表

IArray myParameters = new ArrayClass();

//定义一个输入参数

IGPParameterEdit myP1 = new GPParameterClass();

myParameters.Add(myP1);

myP1.DataType = new GPFeatureLayerTypeClass();

myP1.Value = http://www.mamicode.com/new GPFeatureLayerClass();

myP1.Direction = esriGPParameterDirection.esriGPParameterDirectionInput;

myP1.DisplayName = "Input Features";

myP1.Name = "Input_Features";

myP1.ParameterType = esriGPParameterType.esriGPParameterTypeRequired;

//定义一个输出

IGPParameterEdit myP2 = new GPParameterClass();

myParameters.Add(myP2);

myP2.DataType = new GPDoubleTypeClass();

myP2.Direction = esriGPParameterDirection.esriGPParameterDirectionOutput;

myP2.ParameterType = esriGPParameterType.esriGPParameterTypeDerived;

myP2.DisplayName = "Out FeatureCount";

myP2.DisplayOrder = 0;

myP2.Name = "Out_FeatureCount";

return myParameters;

void Execute(IArray paramvalues, ITrackCancel TrackCancel, IGPEnvironmentManager envMgr, IGPMessages message);

代码执行

//得到第一个参数

IGPParameter parameter = (IGPParameter)paramvalues.get_Element(0);

//IGPValue parameterValue = http://www.mamicode.com/m_GPUtilities.UnpackGPValue(parameter);

// 获取参数值

IFeatureClass inputFeatureClass;

IQueryFilter qf;

m_GPUtilities.DecodeFeatureLayer(parameterValue, out inputFeatureClass, out qf);

if (inputFeatureClass == null)

{

message.AddError(2, "Could not open input dataset.");

return;

}

// 下面就是处理逻辑的代码了

int indexA;

parameter = (IGPParameter)paramvalues.get_Element(1);

string field = parameter.Value.GetAsText();

indexA = inputFeatureClass.FindField(field);

if (indexA < 0)

{

IFieldEdit fieldEdit = new FieldClass();

fieldEdit.Type_2 = esriFieldType.esriFieldTypeDouble;

fieldEdit.Name_2 = field;

inputFeatureClass.AddField(fieldEdit);

}

int featcount = inputFeatureClass.FeatureCount(null);

//设置进度信息

IStepProgressor pStepPro = (IStepProgressor)trackcancel;

pStepPro.MinRange = 0;

pStepPro.MaxRange = featcount;

pStepPro.StepValue = http://www.mamicode.com/(1);

pStepPro.Message = "Calculating Area0";

pStepPro.Position = 0;

pStepPro.Show();

// Create an Update Cursor

indexA = inputFeatureClass.FindField(field);

IFeatureCursor updateCursor = inputFeatureClass.Update(qf, false);

IFeature updateFeature = updateCursor.NextFeature();

IGeometry geometry;

IArea area;

double dArea;

while (updateFeature != null)

{

geometry = updateFeature.Shape;

area = (IArea)geometry;

dArea = area.Area;

updateFeature.set_Value(indexA, dArea);

updateCursor.UpdateFeature(updateFeature);

updateFeature.Store();

updateFeature = updateCursor.NextFeature();

pStepPro.Step();

}

pStepPro.Hide();

//释放资源

System.Runtime.InteropServices.Marshal.ReleaseComObject(updateCursor);

object GetRenderer(IGPParameter pParam);

根据指定的参数返回自定义的渲染器

实现时 返回Null即可。

bool IsLicensed();

验证许可是否通过

IAoInitialize aoi = new AoInitializeClass();

ILicenseInformation licInfo = (ILicenseInformation)aoi;

string licName = licInfo.GetLicenseProductName(aoi.InitializedProduct());

if (licName == "Advanced")

{

return true;

}

else

{

return false;

}

void UpdateMessages(IArray paramvalues, IGPEnvironmentManager pEnvMgr, IGPMessages Messages

给定参数值之后，验证参数信息，并设置返回的消息

IGPMessage msg = (IGPMessage)Messages;

if (msg.IsError())

return;

// Get the first Input Parameter

IGPParameter parameter = (IGPParameter)paramvalues.get_Element(0);

// UnPackGPValue. This ensures you get the value either form the dataelement or GpVariable (ModelBuilder)

IGPValue parameterValue = http://www.mamicode.com/m_GPUtilities.UnpackGPValue(parameter);

// Open the Input Dataset - Use DecodeFeatureLayer as the input might be a layer file or a feature layer from ArcMap.

IFeatureClass inputFeatureClass;

IQueryFilter qf;

m_GPUtilities.DecodeFeatureLayer(parameterValue, out inputFeatureClass, out qf);

IGPParameter3 fieldParameter = (IGPParameter3)paramvalues.get_Element(1);

string fieldName = fieldParameter.Value.GetAsText();

// Check if the field already exists and provide a warning.

int indexA = inputFeatureClass.FindField(fieldName);

if (indexA > 0)

{

Messages.ReplaceWarning(1, "Field already exists. It will be overwritten.");

}

return;

void UpdateParameters(IArray paramvalues, IGPEnvironmentManager pEnvMgr);

更新输入参数

m_Parameters = paramvalues;

// Retrieve the input parameter value

IGPValue parameterValue = http://www.mamicode.com/m_GPUtilities.UnpackGPValue(m_Parameters.get_Element(0));

// Get the derived output feature class schema and empty the additional fields. This will ensure you don‘t get duplicate entries.

IGPParameter3 derivedFeatures = (IGPParameter3)paramvalues.get_Element(2);

IGPFeatureSchema schema = (IGPFeatureSchema)derivedFeatures.Schema;

schema.AdditionalFields = null;

// If we have an input value, create a new field based on the field name the user entered.

if (parameterValue.IsEmpty() == false)

{

IGPParameter3 fieldNameParameter = (IGPParameter3)paramvalues.get_Element(1);

string fieldName = fieldNameParameter.Value.GetAsText();

// Check if the user‘s input field already exists

IField areaField = m_GPUtilities.FindField(parameterValue, fieldName);

if (areaField == null)

{

IFieldsEdit fieldsEdit = new FieldsClass();

IFieldEdit fieldEdit = new FieldClass();

fieldEdit.Name_2 = fieldName;

fieldEdit.Type_2 = esriFieldType.esriFieldTypeDouble;

fieldsEdit.AddField(fieldEdit);

// Add an additional field for the area values to the derived output.

IFields fields = fieldsEdit as IFields;

schema.AdditionalFields = fields;

}

}

IGPMessages Validate(IArray paramvalues, bool updateValues, IGPEnvironmentManager envMgr);

验证信息

if (m_Parameters == null)

m_Parameters = ParameterInfo;

// Call UpdateParameters().

// Only Call if updatevalues is true.

if (updateValues == true)

{

UpdateParameters(paramvalues, envMgr);

}

// Call InternalValidate (Basic Validation). Are all the required parameters supplied?

// Are the Values to the parameters the correct data type?

IGPMessages validateMsgs = m_GPUtilities.InternalValidate(m_Parameters, paramvalues, updateValues, true, envMgr);

// Call UpdateMessages();

UpdateMessages(paramvalues, envMgr, validateMsgs);

// Return the messages

return validateMsgs;

IGPFunctionFactory

方法

说明

string Alias { get; }

别名

UID CLSID { get; }

public UID CLSID

{

get

{

UID id = new UIDClass();

//后面的B很重要

id.Value = http://www.mamicode.com/this.GetType().GUID.ToString("B");

return id;

}

}

string Name { get; }

名称

IGPFunction GetFunction(string Name);

根据GP的名称得到GP对象

IEnumGPEnvironment GetFunctionEnvironments();

如果没有设置全局环境的话，可以返回null。

IGPName GetFunctionName(string Name);

根据名称返回GPName，就是返回GP的 FullName

每次调用都重新实例化对象返回即可

IEnumGPName GetFunctionNames();

返回这个工厂所包含的GPName

每次调用都重新实例化对象返回即可