fmeobjects.fmeworkspacerrunner磅

fmeobjects.FMEWorkspaceRunner的继承图
FMEWorkspaceRunner.getParamDefaultValue（…） 此方法检索由paramName指定的参数的默认值。
FMEWorkspaceRunner.getParamLabel（工作区…） 此方法检索描述由paramname指定的参数的标签字符串。
FMEWorkspaceRunner.getParamOptional（…） 此方法确定工作区上指定的参数名是否为可选参数。
FMEWorkspaceRunner.getParamType（工作区…） 此方法检索指定参数名的参数类型。
FMEWorkspaceRunner.getParamValues（工作区…） 此方法检索指定参数名的可能参数值。
FMEWorkspaceRunner.getPublishedParamNames（…） 此方法检索指定工作区中所有已发布的参数名。
FMEWorkspaceRunner.promptRun（工作区） 执行指定的工作区文件。
FMEWorkspaceRunner.run（工作区） 执行指定的工作区文件。
FMEWorkspaceRunner.runWithParameters（…） 执行使用参数值指定的工作区文件。
FMEWorkspaceRunner.runWithParametersAndDirectives（…） 执行使用参数值和FME指令指定的工作区文件。
班 fmeworkspacerunner软件 磅

基础：对象

FME工作区运行程序类

初始化（）

创建可用于运行FME工作区和检索FME工作区信息的工作区运行器实例。

__初始__ 磅

初始化自身。请参阅帮助（键入（self））以获取准确的签名。

GetParamDefaultValue （ 工作区我是说， 参数名 ） 磅

此方法检索由paramName指定的参数的默认值。如果参数没有默认值，则返回空字符串。

参数:
  • 工作区（str) -包含参数名称的工作区的路径。
  • 参数名（str) -要检索的默认值的参数名。
返回类型:

str
返回:

参数默认值。
提出了:

FMEException-如果在工作空间中没有找到该参数，则会引发异常。
获取参数标签 （ 工作区我是说， 参数名 ） 磅

此方法检索描述由paramname指定的参数的标签字符串。

参数:
  • 工作区（str) -包含参数名称的工作区的路径。
  • 参数名（str) -要检索的标签的参数名称。
返回类型:

str或没有一个
返回:

参数标签字符串。
提出了:

FMEException-如果在工作空间中没有找到该参数，则会引发异常。
getparam可选 （ 工作区我是说， 参数名 ） 磅

此方法确定工作区上指定的参数名是否为可选参数。

参数:
  • 工作区（str) -包含参数名称的工作区的路径。
  • 参数名（str) -参数名，以确定是否可选。
返回类型:

bool或没有一个
返回:

真正的如果参数是可选的，假否则。
提出了:

FMEException-如果在工作空间中没有找到该参数，则会引发异常。
获取参数类型 （ 工作区我是说， 参数名 ） 磅

此方法检索指定参数名的参数类型。

每个参数类型的完整说明可以在以下位置找到：

http://docs.亚搏在线safe.com/fme/html/FME_GuiType/

参数:
  • 工作区（str) -包含参数名称的工作区的路径。
  • 参数名（str) -要检索的类型的参数名。
返回类型:

str或没有一个
返回:

参数类型。
提出了:

FMEException-如果在工作空间中没有找到该参数，则会引发异常。
获取参数值 （ 工作区我是说， 参数名 ） 磅

此方法检索指定参数名的可能参数值。参数值的可用性取决于参数的参数类型。以下是给定特定参数类型时返回参数值的格式示例：

  • 整数:
    • paramValues为空，因为可能的值是整数集。
  • 选择: <价值(% > <value2>]*
    • 每个可能的值之间用“%”分隔。
  • LOOKUP_CHOICE: <displayValue>,<returnValue>][% <displayValue>,<returnValue>]]*
    • 显示值和返回值之间用'，'分隔，返回值是可选的。每个可能的“对”由一个“%”分隔。
  • 文件名: <filterDes>|<过滤器(| < >filterDes2>|<filter2>]*
    • 筛选器描述和筛选器扩展类型由a分隔“|”是的。

以下是对每种参数类型的参数值格式的完整说明：

http://docs.亚搏在线safe.com/fme/html/FME_GuiType/

参数:
  • 工作区（str) -包含参数名称的工作区的路径。
  • 参数名（str) -要检索的值的参数名。
返回类型:

str或没有一个
返回:

可能的参数值。
提出了:

FMEException-如果在工作空间中没有找到该参数，则会引发异常。
getPublishedParamNames （ 工作区 ） 磅

此方法检索指定工作区中所有已发布的参数名。

参数: 工作区（str) -检索参数名称的工作区的路径。
返回类型: 元组(str)或没有一个
返回: 发布的参数名。
提出了: FMEException-如果在指定的工作区中无法检索已发布的参数名，则会引发异常。
提示语 （ 工作区 ） 磅

执行指定的工作区文件。在运行工作区之前，此方法将始终提示输入任何已发布的参数。

除了工作区之外，此方法还将运行映射文件。但是，由于工作区提供的配置方便性，工作区优先于映射文件。

参数: 工作区（str) -要运行的工作区的路径。
返回类型: 没有一个
提出了: FMEException-如果工作区的运行失败，将引发异常。
运行 （ 工作区 ） 磅

执行指定的工作区文件。首次在工作区上调用此方法时，将在运行工作区之前提示输入任何已发布的参数。使用同一工作区对该方法的后续调用不会提示输入已发布的参数。在第一次调用此方法期间指定的已发布参数将在随后的调用中使用。

除了工作区之外，此方法还将运行映射文件。但是，由于工作区提供的配置方便性，工作区优先于映射文件。

参数: 工作区（str) -要运行的工作区的路径。
返回类型: 没有一个
提出了: FMEException-如果工作区的运行失败，将引发异常。
RunWith参数 （ 工作区我是说， 参数 ） 磅

执行使用参数值指定的工作区文件。参数值将指定为名称/值对。例如，对于成对形状，溶孔/否：

>>>跑步者是的。RunWith参数（“workspace.fmw”我是说，{“SHAPE_IN_DISSOLVE_HOLES_SHAPE”我是说，“不”})
参数:
  • 工作区（str) -要运行的工作区的路径。
  • 参数（dict(参数]) -参数名称和值字典。
返回类型:

没有一个
提出了:

FMEException-如果工作区的运行失败，将引发异常。
runwithparameters和指令 （ 工作区我是说， 参数我是说， 指令 ） 磅

执行使用参数值和FME指令指定的工作区文件。参数值和fme指令都将指定为名称/值对。例如，对于参数pair shape_in_dissole_holes_shape/no和fme指令pair log_filename/out.log：

>>>IFMEStringArray*参数=fmeSession->createStringArray();>>>参数->附加（“SHAPE_IN_DISSOLVE_HOLES_SHAPE”);>>>参数->附加（“不”);>>>IFMEStringArray*指令=fmeSession->createStringArray();>>>参数->附加（“LOG_FILENAME”);>>>参数->附加（“out.log”);>>>跑步者->runwithparameters和指令（*工作区我是说，*参数我是说，*指令);
参数:
  • 工作区（str) -要运行的工作区的路径。
  • 参数（dict(参数]) -参数名称和值字典。
  • 指令（dict(指令]) -指令名和值字典。
返回类型:

没有一个
提出了:

FMEException-如果工作空间没有成功运行，将引发异常。