XInterface

Inherited from NULL

Inherited by NULL

Friend class NULL

Description

XInterface提供了XDocument和第三方文件相互转换的统一接口，包括把XDocument里的数据导出为第三方数据文件，或者从第三方数据文件导入数据到XDocument中，或者导出指定分析对象到求解文件中，或者从求解结果中提取指定结果数据。为了提高扩展性，XInterface还提供了接口代理XInterfaceProxy的接口以方便特殊场景的定制。

Public interface

• virtual ErrorCode doExport()
• virtual ErrorCode doImport()
• virtual bool importModel(XModel * mdl)
• virtual ErrorCode exportAnalysis(const char * fname, XModel * mdl, XJob * job)
• virtual void setParam(void * param) = 0
• virtual bool extractData(const char * config, void * dataContainer)
• virtual void setProxy(XInterfaceProxy * Proxy)
• virtual ~XInterface()
• virtual XDocument * getDocument()
• virtual const InterfaceSetting * getSetting()
• virtual int getNextElementID()
• virtual void setNextElementID(int id)

virtual ErrorCode doExport()

• function: 将本地文档的数据导出的接口
• parameters: NULL
• return value:

virtual ErrorCode doImport()

• function: 导入数据并转换到本地文档中
• parameters: NULL
• return value:

virtual bool importModel(XModel * mdl)

• function: 导入模型数据到本地文档中
• parameters:
  1. [i]XModel * mdl:
• return value:

virtual bool exportAnalysis(const XAnalysis * ana, const char * fname)

• function: 导出指定分析设定到求解文件中
• parameters:
  1. [i]const XAnalysis * ana: 指定分析对象
  2. [i]const char * fname: 求解文件名
• return value: 成功导出返回true，否则返回false

virtual void setParam(void * param) = 0

• function: 设置接口参数
• parameters:
  1. [i]void * param: 接口参数指针
• return value: 无

virtual bool extractData(const char * config, void * dataContainer)

• function: 按照配置config提取指定结果
• parameters:
  1. [i]const char * config: 提取配置项，由字符串表达
  2. [i] void * dataContainer: 结果存放容器
• return value: 成功提取返回true，否则返回false

virtual void setProxy(XInterfaceProxy * Proxy)

• function: 设置接口代理，用于适配某些特殊场合的定制化处理
• parameters:
  1. [i]XInterfaceProxy * Proxy: 接口代理
• return value: 无

virtual ~XInterface()

• function: 析构函数
• parameters: NULL
• return value: 无

virtual XDocument * getDocument()

• function: 返回与接口对接的文档
• parameters: NULL
• return value:

virtual const InterfaceSetting * getSetting()

• function: 获取接口设定
• parameters: NULL
• return value: 接口设定