1 # -*- coding: utf-8 -*-
2 # Copyright (C) 2010 EDF R&D
4 # This library is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU Lesser General Public
6 # License as published by the Free Software Foundation; either
7 # version 2.1 of the License.
9 # This library is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 # Lesser General Public License for more details.
14 # You should have received a copy of the GNU Lesser General Public
15 # License along with this library; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 __author__="aribes/gboulant"
23 from daUtils.enumerate import Enumerate
25 from salome.kernel import studyedit
27 import adaoModuleHelper
30 # ==============================================================================
31 # Constant parameters and identifiers
32 # ==============================================================================
34 ADAO_ITEM_TYPES = Enumerate([
39 # ==============================================================================
40 # Function dedicated to the data management in the salome study
41 # ==============================================================================
43 # For developpers, note that the data structures used here are:
44 # - the SALOME study whose API is defined by SALOMEDS::Study
45 # - an item in a study whose API is defined by SALOMEDS:SObject
46 # - a study component, whose API is defined by SALOMEDS::SComponent
47 # a SComponent is a reference in a study toward a SALOME component
50 def addInStudy(salomeStudyId, adaoCase):
52 This function adds in the specified SALOME study a study entry that corresponds
53 to the specified adao case. This study case is put in a folder under
54 the ADAO component and is identified by the case name.
57 studyEditor = studyedit.getStudyEditor(salomeStudyId)
59 adaoRootEntry = studyEditor.findOrCreateComponent(
60 moduleName = adaoModuleHelper.componentName(),
61 componentName = adaoModuleHelper.componentUserName(),
62 icon = adaoModuleHelper.modulePixmap())
64 itemName = adaoCase.name
65 itemValue = adaoCase.filename
66 itemType = ADAO_ITEM_TYPES.ADAO_CASE
68 icon = adaoModuleHelper.studyItemPixmapNOk()
70 icon = adaoModuleHelper.studyItemPixmapOk()
72 salomeStudyItem = studyEditor.createItem(
73 adaoRootEntry, itemName,
78 return salomeStudyItem
80 def updateItem(salomeStudyId, salomeStudyItem, adaoCase):
82 studyEditor = studyedit.getStudyEditor(salomeStudyId)
84 if salomeStudyItem.GetName()[:-2] != adaoCase.name:
85 itemName = adaoCase.name
86 itemValue = adaoCase.filename
88 itemName = salomeStudyItem.GetName()
89 itemValue = adaoCase.get_filename()
91 icon = adaoModuleHelper.studyItemPixmapNOk()
93 icon = adaoModuleHelper.studyItemPixmapOk()
95 studyEditor.setItem(salomeStudyItem,
100 def removeItem(salomeStudyId, item):
102 Remove the item from the specified study.
104 studyEditor = studyedit.getStudyEditor(salomeStudyId)
105 return studyEditor.removeItem(item,True)
108 def isValidAdaoCaseItem(salomeStudyId,item):
110 Return true if the specified item corresponds to a valid adaoCase
115 studyEditor = studyedit.getStudyEditor(salomeStudyId)
116 itemType = studyEditor.getTypeId(item)
117 if itemType != ADAO_ITEM_TYPES.ADAO_CASE: