ForkMaster/geom
1
0
Fork 0
mirror of https://git.salome-platform.org/gitpub/modules/geom.git synced 2025-01-28 08:00:34 +05:00
Code Issues Packages Projects Releases Wiki Activity

XAOPlugin Python API improvements

Browse Source 
- Add missing python doc
- Enable auto-publishing for ImportXAO operation
This commit is contained in:
vsr 2016-03-11 12:02:33 +03:00
parent 1f2a7c5f51
commit 1125dd9734
1 changed files with 44 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
src/GEOM_SWIG/XAOPluginBuilder.py
View File

@ -31,12 +31,25 @@ def GetXAOPluginOperations(self):
# @param shape The shape to export # @param shape The shape to export
# @param groups The list of groups to export # @param groups The list of groups to export
# @param fields The list of fields to export # @param fields The list of fields to export
# @param author The author of the export # @param author The author of the file
# @param fileName The name of the file to export # @param fileName The name of the file to export
# @return boolean # @return True if operation is successful or False otherwise
# #
# @ingroup l2_import_export # @ingroup l2_import_export
def ExportXAO(self, shape, groups, fields, author, fileName): def ExportXAO(self, shape, groups, fields, author, fileName):
"""
Export a shape to XAO format
Parameters:
shape The shape to export
groups The list of groups to export
fields The list of fields to export
author The author of the file
fileName The name of the file to export
Returns:
True if operation is successful or False otherwise
"""
from salome.geom.geomBuilder import RaiseIfFailed from salome.geom.geomBuilder import RaiseIfFailed
anOp = GetXAOPluginOperations(self) anOp = GetXAOPluginOperations(self)
res = anOp.ExportXAO(shape, groups, fields, author, fileName) res = anOp.ExportXAO(shape, groups, fields, author, fileName)
@ -45,17 +58,39 @@ def ExportXAO(self, shape, groups, fields, author, fileName):
## Import a shape from XAO format ## Import a shape from XAO format
# @param fileName The name of the file to import # @param fileName The name of the file to import
# @return tuple (res, shape, subShapes, groups, fields) # @param theName Object name; when specified, this parameter is used
# res Flag indicating if the import was successful # for result publication in the study. Otherwise, if automatic
# shape The imported shape # publication is switched on, default value is used for result name.
# subShapes The list of imported subShapes #
# groups The list of imported groups # @return tuple (\a res, \a shape, \a subShapes, \a groups, \a fields)
# fields The list of imported fields # \a res Flag indicating if the import was successful
# \a shape The imported shape
# \a subShapes The list of imported subShapes
# \a groups The list of imported groups
# \a fields The list of imported fields
# #
# @ingroup l2_import_export # @ingroup l2_import_export
def ImportXAO(self, fileName): def ImportXAO(self, fileName, theName=None):
"""
Import a shape from XAO format
Parameters:
fileName The name of the file to import
theName Object name; when specified, this parameter is used
for result publication in the study. Otherwise, if automatic
publication is switched on, default value is used for result name.
Returns:
A tuple (res, shape, subShapes, groups, fields):
- res: Flag indicating if the import was successful
- shape: The imported shape
- subShapes: The list of imported subShapes
- groups: The list of imported groups
- fields: The list of imported fields
"""
from salome.geom.geomBuilder import RaiseIfFailed from salome.geom.geomBuilder import RaiseIfFailed
anOp = GetXAOPluginOperations(self) anOp = GetXAOPluginOperations(self)
res = anOp.ImportXAO(fileName) res = anOp.ImportXAO(fileName)
RaiseIfFailed("ImportXAO", anOp) RaiseIfFailed("ImportXAO", anOp)
self._autoPublish(res[1], theName, "imported")
return res return res