PipeSystem

类：元素信息——管道拓扑分析

Methods

clearFlowEffectMaterial()

取消设置管道构件的水流动画材质

getAdjacentComponentsByConditions(component, condition, callback)

按筛选条件获取管道构件所在上下游流动路径中连接关系最近的管道构件

Parameters:

Name	Type	Description
component	Object	管道构件信息
fileId	String	若为集成模型，需要填写对应子文件的fileId；若为单模型，可不填；
componentId	String	对应构件Id
condition	Object	筛选条件，必须填写。
type	String	选择上游或下游的临近构件；若不填写默认为下游。上游：upstream；下游：downstream；
filter	Array	过滤条件，例如：[{"type":"BRAN"}]；必须填写。
callback	Function	回调函数

Returns:

Type	Description
Promise	异步处理对象，通过.then((data) => console.log(data))返回获取到的数据；也支持callback回调函数的形式返回信息；返回管道系统信息

getComponentsBySystemId(system, conditions, callback)

依据筛选条件，获取管道系统内的构件id列表。可选的筛选条件为构件的拓扑属性及部分基础属性：name、type、id、flowFrom、flowInto

Parameters:

Name	Type	Description
system	Object	系统信息
fileId	String	若为集成模型，需要填写对应子文件的fileId；若为单模型，可不填；
systemId	String	对应系统Id
conditions	Array	筛选条件，如：[{"type":"fran","flowFrom":"123"}]；如不需要筛选则输入空数组[]。
callback	Function	回调函数

Returns:

Type	Description
Promise	异步处理对象，通过.then((data) => console.log(data))返回获取到的数据；也支持callback回调函数的形式返回信息；返回构件id列表

getConnectedComponentsByConditions(component, condition, callback)

依据筛选条件获取管道构件的临近构件

Parameters:

Name	Type	Description
component	Object	管道构件信息
fileId	String	若为集成模型，需要填写对应子文件的fileId；若为单模型，可不填；
componentId	String	对应构件Id
condition	Object	筛选条件,如不需要则输入空对象{}。
type	String	选择上游或下游的临近构件；上游：upstream；下游：downstream；
filter	Array	过滤条件，例如：[{"type":"BRAN"}]；如不需要过滤则输入空数组[]。
callback	Function	回调函数

Returns:

Type	Description
Promise	异步处理对象，通过.then((data) => console.log(data))返回获取到的数据；也支持callback回调函数的形式返回信息；返回附近的管道构件ID列表

getDownstreamComponentsById(component, condition, callback)

获取管道构件的下游构件

Parameters:

Name	Type	Description
component	Object	管道构件信息
fileId	String	若为集成模型，需要填写对应子文件的fileId；若为单模型，可不填；
componentId	String	对应构件Id
condition	Array	筛选条件，例如：[{"type":"BRAN"}]；设置筛选条件后，可以获取下游符合该筛选条件的构件，若如不需要过滤则输入空数组[]。
callback	Function	回调函数

Returns:

Type	Description
Promise	异步处理对象，通过.then((data) => console.log(data))返回获取到的数据；也支持callback回调函数的形式返回信息；返回管道下游构件信息

getFlowPathByIds(conditions, callback)

获取管道之间的流动路径。依据给定的两个管道构件，可以获取构件之间的流动路径

Parameters:

Name	Type	Description
conditions	Object	流动条件
fileId	String	若为集成模型，需要填写对应子文件的fileId；若为单模型，可不填；
startComponentId	String	起点管道构件id，必填
endComponentId	String	终点管道构件id，必填
limit	Number	限制路径条数
callback	Function	回调函数

Returns:

Type	Description
Promise	异步处理对象，通过.then((data) => console.log(data))返回获取到的数据；也支持callback回调函数的形式返回信息；返回管道路径信息

getSystems(callback)

获取模型的管道系统信息

Parameters:

Name	Type	Description
callback	Function	回调函数

Returns:

Type	Description
Promise	异步处理对象，通过.then((data) => console.log(data))返回获取到的数据；也支持callback回调函数的形式返回信息；返回管道系统信息

getTopologyPropertiesById(component, callback)

获取管道构件的拓扑属性信息

Parameters:

Name	Type	Description
component	Object	管道构件信息
fileId	String	若为集成模型，需要填写对应子文件的fileId；若为单模型，可不填；
componentId	String	对应构件Id
callback	Function	回调函数

Returns:

Type	Description
Promise	异步处理对象，通过.then((data) => console.log(data))返回获取到的数据；也支持callback回调函数的形式返回信息；返回管道构件拓扑关系属性信息

getTopologyPropertiesByIds(components, callback)

批量获取管道构件的拓扑属性信息

Parameters:

Name	Type	Description
components	Object	管道构件信息
fileId	String	若为集成模型，需要填写对应子文件的fileId；若为单模型，可不填；
componentIds	Array	对应构件Id列表
callback	Function	回调函数

Returns:

Type	Description
Promise	异步处理对象，通过.then((data) => console.log(data))返回获取到的数据；也支持callback回调函数的形式返回信息；返回管道构件拓扑关系属性信息

getUpstreamComponentsById(component, condition, callback)

获取管道构件的上游构件

Parameters:

Name	Type	Description
component	Object	管道构件信息
fileId	String	若为集成模型，需要填写对应子文件的fileId；若为单模型，可不填；
componentId	String	对应构件Id
condition	Array	筛选条件，例如：[{"type":"BRAN"}]；设置筛选条件后，可以获取上游符合该筛选条件的构件，若如不需要过滤则输入空数组[]。
callback	Function	回调函数

Returns:

Type	Description
Promise	异步处理对象，通过.then((data) => console.log(data))返回获取到的数据；也支持callback回调函数的形式返回信息；返回管道上游构件信息

setFlowEffectMaterialByIds(components, callback)

批量设置水流动画材质，只有在管道系统分析后，属于管道系统的构件才可以附着水流动画材质。附着后的材质可通过material类管理。

Parameters:

Name	Type	Description
components	Object	管道构件信息
fileId	String	若为集成模型，需要填写对应子文件的fileId；若为单模型，可不填；
componentIds	Array	对应构件Id列表
callback	Function	回调函数

Returns:

Type	Description
Promise	异步处理对象，通过.then((data) => console.log(data))返回获取到的数据；也支持callback回调函数的形式返回信息；返回管道构件材质信息：[material1,material2,..]