# 查询模块

# 模块名称： Query

# 查询实体ID

接口名称： getEntityIdByFeatureName
输入参数：

参数名称	参数含义	类型	必须	参数值说明
featureName	特征的标识名	字符串	是	查找实体的ID

返回值： EntityId（整数）

//示例程序: 
Query.getEntityIdByFeatureName('featureName');

1
2

# 查询特征ID

接口名称： getFeatureIdByFeatureName
输入参数：

参数名称	参数含义	类型	必须	参数值说明
featureName	特征的标识名	字符串	是	查找特征的ID

返回值： FeatureId（整数）

//示例程序:
Query.getFeatureIdByFeatureName('featureName');

1
2

# 查询装配实例ID

接口名称： getInstanceIdByFeatureName
输入参数：

参数名称	参数含义	类型	必须	参数值说明
featureName	特征的标识名	字符串	是	查找实例的ID

返回值： FeatureId（字符串）

//示例程序:
Query.getInstanceIdByFeatureName('featureName');

1
2

# 通过实体名查询实体Id

接口名称： getEntityIdByEntityName
输入参数：

参数名称	参数含义	类型	必须	参数值说明
entityName	实体的名字	字符串	是	查找实体的名字
instanceId	实例的Id	字符串	否	装配中使用API时需要的参数

返回值： EntityIds（List）

//示例程序:
Query.getEntityIdByEntityName('entityName');

1
2

# 通过实体类型查找当前零件中的所有对应实体Id

接口名称： getEntityIdsByEntityType
输入参数：

参数名称	参数含义	类型	必须	参数值说明
entityType	实体的类型	内置enum类型	是	类型有:EntityType.(Solid/Sketch/Surface/Curve/DatumPlane/DatumLine)
instanceId	实例的Id	字符串	否	装配中使用API时需要的参数

返回值： EntityIds（List）

//示例程序:
Query.getEntityIdsByEntityType(EntityType.Solid);

1
2

# 通过通过元素类型查找实体中对应的元素Id

接口名称： getElementIdsByElementType
输入参数：

参数名称	参数含义	类型	必须	参数值说明
entityId	实体的Id	整数	是
elementType	元素的类型	内置enum类型	是	类型有:ElementType.(Face/Edge/Vertex)
instanceId	实例的Id	字符串	否	装配中使用API时需要的参数

返回值： ElementIds（List）

//示例程序:
Query.getElementIdsByElementType(entityId, ElementType.Face);

1
2

# 查询边的端点

接口名称： getVertexIdByEdgeId
输入参数：

参数名称	参数含义	类型	必须	参数值说明
edgeId	边线的Id	整数	是
instanceId	实例的Id	字符串	否	装配中使用API时需要的参数

返回值： VertexIds（List）

//示例程序:
Query.getVertexIdByEdgeId(edgeId);

1
2

# 查询实体中与输入线平行的边

接口名称： getParallelEdgeIdsByEdgeId
输入参数：

参数名称	参数含义	类型	必须	参数值说明
entityId	实体的Id	整数	是	查找实体的Id
edgeId	输入线的id	整数	是
instanceId	实例的Id	字符串	否	装配中使用API时需要的参数

返回值： EdgeIds（List）

//示例程序:
Query.getParallelEdgeIdsByEdgeId('entityName');

1
2

# 查询实体中边或者面相邻的其它面

接口名称： getBoundedFaceIdsByFaceOrEdge
输入参数：

参数名称	参数含义	类型	必须	参数值说明
elementId	边或者面的Id	整数	是
instanceId	实例的Id	字符串	否	装配中使用API时需要的参数

返回值： FaceIds（List）

//示例程序:
Query.getBoundedFaceIdsByFaceOrEdge('entityName');

1
2

# 通过Id查询相关实体、元素的属性

接口名称： getElementInfoById
输入参数：

参数名称	参数含义	类型	必须	参数值说明
elementId	元素、实体的Id	整数	是
instanceId	实例的Id	字符串	否	装配中使用API时需要的参数

返回值： Id对应的属性对象（KVObject）

//示例程序:
Query.getElementInfoById('entityName');

1
2

# 查询变量信息

接口名称： getVariableValue
输入参数：

参数名称	参数含义	类型	必须	参数值说明
variableName	变量名	字符串	是	查找实体的ID

返回值：包含变量信息的对象（KVObject）

//示例程序: 
Query.getVariableValue('variableName');

1
2

# 获取全部变量信息

接口名称： getAllVariable
输入参数：无
返回值：包含变量信息的数组（List）

//示例程序: 
Query.getAllVariable();

1
2