作者： dashi

力控组态软件ForceControl V7.0设置后台组件配方信息的控件方法

PopManageDlg()
描述： 弹出配方管理界面
返回值： 无
参数： 无
说明： 本函数弹出的是整个配方的管理界面，在该界面中可以进行关于配方的所有操作
示例： #pRecipe.PopManageDlg()// 弹出管理对话框

PopSetRecipeDlg(string RecipeName)
描述： 弹出配方设置界面
返回值： void
参数： RecipeName – string，需要编辑的配方名称
说明： 执行本函数是提供一种界面修改配方内容的方法，以方便现场对配方的操作
示例： #pRecipe.PopSetRecipeDlg(“RecipeName”)// 弹出配方设置界面来修改配方 RecipeName

RenameMaterial(sting RecipeName,sting MaterialVarName,sting NewMaterialVarName)
描述： 修改原料名称
返回值： int 0- 失败 1- 成功
参数： RecipeName – 字符串，配方名称
MaterialVarName – 字符串，原料变量名称
NewMaterialVarName – 字符串，原料变量名称
说明： 将名称为 MaterialVarName 的原料变量名称改为 NewMaterialVarName 失败返回 0
示例： #pRecipe.RenameMaterial(“Recipe1″,”Tag1.pv”,”tag2.pv”)
// 将原料名称由 Tag1.pv 改为 Tag2.pv

SaveFile(string Path,string SaveName)
描述： 存储配方组到文件
返回值： int 1- 成功，0- 失败
参数： Path – 字符串，保存文件路径
SaveName – 字符串，存储文件的名称
说明： 将当前的配方组保存到 Path 路径下的 SaveName 文件中，存储文件格式有 xml 和 rcp两种，因此存储时只需要输入配方名称不需要写后缀名，默认为 xml 格式，当本配法组加密时导出的是 rcp 格式，并且加密；如果输入路径为空则默认存入工程目录 Recipe下 ;Path 如不存在则自动创建 Path 各级文件夹。
示例： #pRecipe.SaveFile（”C:\Program Files\PCAuto6″,”abc”)
// 将 pRecipe 配方组保存到 C:\Program Files\PCAuto6 下的 abc 文件下

SetForceValueState(string RecipeName,int bForceVale)
描述： 设置配方强制值执行状态
返回值： int 0- 失败 1- 成功
参数： RecipeName – 字符串，配方名称
bForceVale – 整型，强制值状态，0 为不执行强制值，1 为执行
说明： 设置配方强制值执行状态，设置 0 为不执行强制值，1 为执行
示例： #pRecipe.SetForceValueState(“beerRcp”,1)// 设置配方 “beerRcp” 配方执行强制值

SetMaterialDescription(stringRecipeName,stringMaterialName,string Describtion)
描述： 设置配方中某一个原料的描述信息
返回值： int 0- 失败 1- 成功
参数： RecipeName – 字符串，配方名称，为字符串
MaterialName – 字符串，原料名称
Describtion – 字符串，原料描述
说明： 设置配方中某一个原料的描述信息。成功则返回非零，失败为 0
示例： #pRecipe.SetMaterialDescription(“RecipeName”,”MaterialName”,
“Describtion”)// 设置配方 RecipeName 的 MaterialName 原料的描述信息为 Describtion

SetMaterialExpression(string RecipeName,string MaterialName,string Expression)
描述： 设置配方中某一原料的表达式
返回值： int 0- 失败 1- 成功
参数： RecipeName – 字符串，配方名称
MaterialName – 字符串，原料名称
Expression – 字符串，表达式名称
说明： 设置配方中某一项原料的表达式，失败返回 0
示例： #pRecipe.SetMaterialExpression(“Beer”,”Tag1.pv”,”Tag0.pv * 0.5″)
// 设置配方 Beer 中 Tag1.pv 原料的表达式为 Tag0.pv * 0.5，失败返回 0

SetMaterialForceValue(string RecipeName,string MaterialName, float ForceValue)
描述： 设置配方中某一原料的强制值
返回值： int 0- 失败 1- 成功
参数： RecipeName – 字符串，配方名称
MaterialName – 字符串，原料名称
ForceValue – 浮点数，强制值名称
说明： 设置配方中某一项原料的强制值，失败返回 0
示例： #pRecipe.SetMaterialForceValue(“Beer”,”Tag1.pv”,”158″)
// 设置配方 Beer 中 Tag1.pv 原料的强制值为 158

SetMaterialReferVar(stringRecipeName,string MaterialName,string Referencevar)
描述： 设置配方中某一个原料的参考变量
返回值： int 0- 失败 1- 成功
参数： RecipeName – 字符串，配方名称，为字符串
MaterialName – 字符串，原料名称
Referencevar – 字符串，参考变量名称
说明： 设置配方中某一个原料的参考变量。失败返回 0
示例： #pRecipe.SetMaterialReferVar(“RecipeName”,”MaterialName”,
“Referencevar”)// 设置配方 RecipeName 的 MaterialName 原料的参考变量为 Referencevar

SetMaterialUnit(string RecipeName,string MaterialName,string Unit)
描述： 设置配方中某一原料的单位
返回值： int 0- 失败 1- 成功
参数： RecipeName – 字符串，配方名称，为字符串
MaterialName – 字符串，原料名称
Unit – 字符串，单位名称
说明： 设置配方中某一项原料的单位
示例： #pRecipe.SetMaterialUnit(“Beer”,”Tag1.pv”,”T”)// 设置配方 Beer 中 Tag1.pv 原料的单位为 T

SetProductNO(sting RecipeName,sting strProNO)
描述： 设置配方对应的产品编号
返回值： int 0- 失败 1- 成功
参数： Recipename- 配方名称字符串
strProNO- 产品编号字符串
说明： 该函数用来设置配方对应的产品编号
示例： #pRecipe.SetProductNO(“Beer”,”abc111-5″)// 设

力控组态软件ForceControl V7.0获取后台组件配方信息的控件方法

GetForceValeState(“RecipeName”)
描述： 获得配方使用强制值的状态。
返回值： int 0- 不使用强制值，1- 使用强制值
参数： RecipeName – 字符串，配方名称，为字符串
说明： 获得配方使用强制值的状态
示例： bForceVale = #pRecipe.GetForceValeState(“Beer”)// 获得配方 Beer 的强制值状态赋给 bForceVale。0 为不允许使用

GetMaterialCount(string RecipeName)
描述： 获得配方 RecipeName 的原料数
返回值： int- 配方原料数量
参数： RecipeName – 配方名称字符串
说明： 该函数获得给定配方的原料数目。如果返回失败则返回 -1
示例： nCount= #pRecipe.GetMaterialCount(“Beer”) // 获得配方 Beer 的原料数目，并赋给nCount

GetMaterialDescription(string RecipeName,string MaterialName)
描述： 获得配方中某一个原料的描述信息
返回值： string
参数： RecipeName – 字符串，配方名称
MaterialName – 字符串，原料名称
说明： 获得配方中某一个原料的描述信息
示例： tag1.desc = #pRecipe.GetMaterialDescription(“Beer”,”tag.pv”)
// 获得配方 Beer 的 tag.pv 原料的描述信息并赋给变量 tag1.desc

GetMaterialExpression(string RecipeName,string MaterialVarName)
描述： 获得配方中一原料的表达式
返回值： string
参数： RecipeName – 字符串，配方名称
MaterialVarName – 字符串，原料变量名称
说明： 获得给定配方某一原料的表达式，失败则返回空
示例： strVar = #pRecipe.GetMaterialExpression(“Beer”,”Tag1.pv”)// 得到配方 Beer 中Tag1.pv 原料的表达式值，并赋给 strVar

GetMaterialForceValue(string RecipeName,string MaterialName)
描述： 获得配方中某一原料的强制值
返回值： float
参数： RecipeName – 字符串，配方名称
MaterialName – 字符串，原料名称
说明： 获得配方中某一项原料的强制值，失败返回 -2, 没有强制值返回 -1
示例： fVar = #pRecipe.GetMaterialForceValue(“Beer”,”Tag1.pv”)// 获得配方 Beer 中 Tag1.pv原料的强制值赋给 fVar，失败返回 -2, 没有强制值返回 -1

GetMaterialName(string RecipeName,int index)
描述： 获得配方中某个序号的原料名称
返回值： string
参数： RecipeName – 字符串，需要编辑的配方名称
index – int，序号
说明： 执行本函数将获得某个配方的第 index 项原料的名称
示例： strRecipeName = #pRecipe.GetMaterialName(“Recipe1”,index)
// 获得配方 Recipe1 第 index 项的名称，并赋给 strRecipeName

GetMaterialReferVar(string RecipeName,string MaterialName)
描述： 获得配方中某一个原料的参考变量
返回值： string
参数： RecipeName – 字符串，配方名称，为字符串
MaterialName – 字符串，原料名称
说明： 获得配方中某一个原料的参考变量
示例： Referencevar = #pRecipe.GetMaterialReferVar(“Beer”,”tag.pv”)
// 获得配方 Beer 的 tag.pv 原料的参考变量赋给变量 Referencevar

GetMaterialUnit(string RecipeName,string MaterialName)
描述： 获得配方中某一原料的单位
返回值： string
参数： RecipeName – 字符串，配方名称
MaterialName – 字符串，原料名称
说明： 获得配方中某一项原料的单位
示例： strVar = #pRecipe.GetMaterialUnit(“Beer”,”Tag1.pv”)
// 获得配方 Beer 中 Tag1.pv 原料的单位赋给 strVar

GetMaterialValue(string RecipeName,string MaterialVarName)
描述： 获得给定配方某一原料的值
返回值： float- 原料项对应的值
参数： RecipeName – 字符串，配方名称
MaterialVraName – 字符串，原料名称
说明： 获得给定配方某一原料的值，失败则返回 -1
示例： fVar = #pRecipe.GetMaterialValue(“Beer”,”Tag1.pv”)// 得到配方 Beer 中 Tag1.pv原料的值

GetProductNO(string RecipeName)
描述： 获得配方对应的产品编号
返回值： string- 产品编号
参数： Recipename- 配方名称字符串
说明： 该函数获得配方对应的产品编号
示例： StrProNO = #pRecipe.GetProductNO(“Beer”)// 获得 Beer 配方对应产品编号并且赋给 StrProNo

GetRcpCount()
描述： 获得该配方组中包含的配方数。
返回值： int 配方组中的配方数
参数： 无
说明： 执行本函数将获得某个配方组中包含配方数。
示例： int nRcpCount = #pRecipe.GetRcpCount();;
// 获得该配方组 pRecipe 中包含的配方数 , 并赋给 nRcpCount。

GetRcpNameByIndex(int n)
描述： 通过索引号获得配方的名字
返回值： 字符串 配方名字字符串
参数： int- 索引号，以 0 开始
说明： 通过索引号获得配方的名字，该方法一般与 GetRcpCount 配合使用
示例： string strRcpName = #pRecipe.GetRcpNameByIndex(5);
// 获得配方组 pRecipe 中索引号为 5 的配方的名字，赋给 strRcpName

LoadFile(string Path, string FileName)
描述： 将配方组装载到系统中
返回值：i nt 0- 失败，1- 成功
参数： Path – 字符串，文件的存储路径
FileName – 字符串，装载文件名称
说明： 将文件 FileName 装载进当前的配方组中，装载的文件必须是本配方组件生成的 xml 和rcp 格式的文件，如果路径为空则默认去工程目录下查找。
示例： #pRecipe.LoadFile(“C:\Program Files\PCAuto6″,”abc.xml”)
// 将力控目录下的 abc.xml 文件中保存的配方装载到 pRecipe 配方组中

力控组态软件ForceControl V7.0添加删除和下载后台组件配方的控件方法

AddMaterial(stingRecipeName,stringMaterialVariable,stingExpression,doubleForceValue,sting Unit,sting Describe,sting ReferenceVariable)
描述： 在给定配方中添加配方原料项
返回值： int 0- 失败 1- 成功
参数： RecipeName – 字符串，配方名称，为字符串，必选项
MaterialVariable- 字符串，原料对应变量名称，必选项
Expression – 字符串，表达式，必选项
ForceValue – 双精度型，强制值设定，当用户需要设置强制值模式时有效，可选项
Unit – 字符串，原料的单位描述，可选项
Describe – 字符串，原料的描述，可选项
Reference – 变量名，用于提供用户对该原料的某个变量的参考用可选项
说明： 函数获在给定配方中添加新的原料项，如果配方不存在则创建新的配方，如果添加失败返回 0，成功返回 1
示例： #pRecipe.AddMaterial(“Recipe1″,”Tag1.pv”,”Gross * 0.2″,5.6,” 新添加的原料项”,”T”,”Gross.pv”);// 在配方 RecipeName 中添加原料 Tag1.pv，并且设定其相关的参数

AddRecipe(string RecipeName)
描述： 添加配方
返回值： int 0- 失败 1- 成功
参数： RecipeName – 配方名称的字符串
说明： 在配方组中添加一个新的配方
示例： #pRecipe.AddRecipe(“RecipeName”)// 添加名称为 RecipeName 的新配方到pRecipe 配方组中，如果失败则返回 0

DeleteMaterial(sting RecipeName,sting MaterialName)
描述： 删除给定配方中原料项
返回值： int 0- 失败 1- 成功
参数： RecipeName – 字符串，配方名称，为字符串，必选项
MaterialName – 字符串，原料名称，必选项
说明： 删除给定配方中原料项，如果删除失败返回 0
示例： #pRecipe.DeleteMaterial(“Recipe1″,”Tag1.pv”)// 删除 Recipe1 配方中的 Tag1.pv 原料项

DeleteRecipe(string RecipeName)
描述： 删除配方
返回值： int 0- 为删除失败，1- 删除成功
参数： RecipeName- 配方名称的字符串
说明： 配方是从内存中把名字为 RecipeName 的配方删除，返回值为 0 时表示删除失败
示例： #pRecipe.DeleteRecipe(“Beer”)// 删除配方 Beer，如果删除成功返回 1，不成功返回 0

ExcuteRecipeByIndex(int Index)
描述： 将配方的值下载到现场中去
返回值： int 0- 失败 1- 成功
参数： Index – 配方在配方组中的序列号
说明： 执行该函数先将配方中各个变量的值进行计算，如果计算正确则将所有数据下载到现场中去，如果计算失败或者下载失败则返回 0
示例： #pRecipe.ExcuteRecipeByIndex(9)// 将配方组 pRecipe 中第 10 个配方的值下载到现场中去

ExcuteRecipeByName(string RecipeName)
描述： 将配方的值下载到现场中去
返回值： int 0- 失败 1- 成功
参数： RecipeName- 字符串变量或者字符串
说明： 执行该函数先将配方中各个变量的值进行计算，如果计算正确则将所有数据下载到现场中去，如果计算失败或者下载失败则返回 0
示例： #pRecipe.ExcuteRecipeByName(“Recipe”)// 将配方 Recipe 的值下载到现场中去