This class provides utility methods to complement Study and StudyBuilder classes. More...
Public Member Functions | |
| def | study (self) |
| def | builder (self) |
| def | lcc (self) |
| def | findOrCreateComponent (self, moduleName, componentName=None, icon=None, containerName=_DEFAULT_CONTAINER) |
| Find a component corresponding to the Salome module moduleName in the study. More... | |
| def | loadComponentEngine (self, sComponent, containerName=_DEFAULT_CONTAINER) |
| Load the engine corresponding to sComponent in the container containerName, associate the engine with the component and load the CORBA objects of this component in the study. More... | |
| def | getOrLoadObject (self, item) |
| Get the CORBA object associated with the SObject item, eventually by first loading it with the corresponding engine. More... | |
| def | findOrCreateItem (self, fatherItem, name, fileType=None, fileName=None, comment=None, icon=None, IOR=None, typeId=None) |
| Find an object under fatherItem in the study with the given attributes. More... | |
| def | findItem (self, fatherItem, name=None, fileType=None, fileName=None, comment=None, icon=None, IOR=None, typeId=None) |
| Find an item with given attributes under fatherItem in the study. More... | |
| def | createItem (self, fatherItem, name, fileType=None, fileName=None, comment=None, icon=None, IOR=None, typeId=None) |
| Create a new object named name under fatherItem in the study, with the given attributes. More... | |
| def | setItem (self, item, name=None, fileType=None, fileName=None, comment=None, icon=None, IOR=None, typeId=None) |
| Modify the attributes of an item in the study. More... | |
| def | removeItem (self, item, withChildren=False) |
| Remove the given item from the study. More... | |
| def | setItemAtTag (self, fatherItem, tag, name=None, fileType=None, fileName=None, comment=None, icon=None, IOR=None, typeId=None) |
| Find an item tagged tag under fatherItem in the study tree or create it if there is none, then set its attributes. More... | |
| def | getName (self, sObject) |
| Return the name of the object sObject. More... | |
| def | setName (self, sObject, name) |
| Set the name of the object sObject. More... | |
| def | getComment (self, sObject) |
| Return the comment of the object sObject. More... | |
| def | setComment (self, sObject, comment) |
| Set the comment of the object sObject. More... | |
| def | getAttributeValue (self, sObject, attributeName, default=None) |
| Return the value of the attribute named attributeName on the object sObject, or default if the attribute doesn't exist. More... | |
| def | setAttributeValue (self, sObject, attributeName, attributeValue) |
| Set the value of the attribute named attributeName on the object sObject to the value attributeValue. More... | |
| def | getTypeId (self, sObject) |
| Return the value of the attribute "AttributeLocalID" of the object sObject, or None if it is not set. More... | |
| def | setTypeId (self, sObject, value) |
| Set the attribute "AttributeLocalID" of the object sObject to the value value. More... | |
| def | getFileType (self, sObject) |
| Return the value of the attribute "AttributeFileType" of the object sObject, or an empty string if it is not set. More... | |
| def | setFileType (self, sObject, value) |
| Set the attribute "AttributeFileType" of the object sObject to the value value. More... | |
| def | getFileName (self, sObject) |
| Return the value of the attribute "AttributeExternalFileDef" of the object sObject, or an empty string if it is not set. More... | |
| def | setFileName (self, sObject, value) |
| Set the attribute "AttributeExternalFileDef" of the object sObject to the value value. More... | |
| def | getIcon (self, sObject) |
| Return the value of the attribute "AttributePixMap" of the object sObject, or an empty string if it is not set. More... | |
| def | setIcon (self, sObject, value) |
| Set the attribute "AttributePixMap" of the object sObject to the value value. More... | |
This class provides utility methods to complement Study and StudyBuilder classes.
Those methods may be moved in those classes in the future. The preferred way to get a StudyEditor object is through the method getStudyEditor which allows to reuse existing instance or through the global module attribute EDITOR.
| lcc | This instance attribute provides access to the SALOME life cycle CORBA service. |
| study | This instance attribute provides access to the Study object. It can be used to access the study but the attribute itself cannot be modified. |
| builder | This instance attribute provides access to the StudyBuilder object. It can be used to edit the study but the attribute itself cannot be modified. |
This class provides utility methods to complement :class:`Study` and :class:`StudyBuilder` classes. Those methods may be moved in those classes in the future. The preferred way to get a StudyEditor object is through the method :meth:`getStudyEditor` which allows to reuse existing instances. .. attribute:: lcc This instance attribute provides access to the SALOME life cycle CORBA service. .. attribute:: study This instance attribute provides access to the :class:`Study` object. It can be used to access the study but the attribute itself cannot be modified. .. attribute:: builder This instance attribute provides access to the :class:`StudyBuilder` object. It can be used to edit the study but the attribute itself cannot be modified.
| def KERNEL_PY.kernel.studyedit.StudyEditor.builder | ( | self | ) |
Attribute that provides access to the study builder.
References salome.salome_init().
Referenced by studyedit.StudyEditor.createItem(), KERNEL_PY.kernel.studyedit.StudyEditor.createItem(), studyedit.StudyEditor.findOrCreateComponent(), KERNEL_PY.kernel.studyedit.StudyEditor.findOrCreateComponent(), studyedit.StudyEditor.getAttributeValue(), KERNEL_PY.kernel.studyedit.StudyEditor.getAttributeValue(), studyedit.StudyEditor.getIcon(), KERNEL_PY.kernel.studyedit.StudyEditor.getIcon(), studyedit.StudyEditor.loadComponentEngine(), KERNEL_PY.kernel.studyedit.StudyEditor.loadComponentEngine(), studyedit.StudyEditor.removeItem(), KERNEL_PY.kernel.studyedit.StudyEditor.removeItem(), studyedit.StudyEditor.setAttributeValue(), KERNEL_PY.kernel.studyedit.StudyEditor.setAttributeValue(), studyedit.StudyEditor.setComment(), KERNEL_PY.kernel.studyedit.StudyEditor.setComment(), studyedit.StudyEditor.setIcon(), KERNEL_PY.kernel.studyedit.StudyEditor.setIcon(), studyedit.StudyEditor.setItem(), KERNEL_PY.kernel.studyedit.StudyEditor.setItem(), studyedit.StudyEditor.setItemAtTag(), KERNEL_PY.kernel.studyedit.StudyEditor.setItemAtTag(), studyedit.StudyEditor.setName(), and KERNEL_PY.kernel.studyedit.StudyEditor.setName().
| def KERNEL_PY.kernel.studyedit.StudyEditor.createItem | ( | self, | |
| fatherItem, | |||
| name, | |||
fileType = None, |
|||
fileName = None, |
|||
comment = None, |
|||
icon = None, |
|||
IOR = None, |
|||
typeId = None |
|||
| ) |
Create a new object named name under fatherItem in the study, with the given attributes.
If an object named name already exists under the father object, the new object is created with a new name name_X where X is the first available index.
param fatherItem (SObject) item under which the new item will be added.
See setItem() for the description of the other parameters.
Create a new object named `name` under `fatherItem` in the study, with the given attributes. If an object named `name` already exists under the father object, the new object is created with a new name `name_X` where X is the first available index. :type fatherItem: SObject :param fatherItem: item under which the new item will be added. :return: new SObject created in the study See :meth:`setItem` for the description of the other parameters.
References studyedit.StudyEditor.builder(), KERNEL_PY.kernel.studyedit.StudyEditor.builder(), studyedit.StudyEditor.setItem(), KERNEL_PY.kernel.studyedit.StudyEditor.setItem(), studyedit.StudyEditor.study(), and KERNEL_PY.kernel.studyedit.StudyEditor.study().
Referenced by studyedit.StudyEditor.findOrCreateItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.findOrCreateItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.findItem | ( | self, | |
| fatherItem, | |||
name = None, |
|||
fileType = None, |
|||
fileName = None, |
|||
comment = None, |
|||
icon = None, |
|||
IOR = None, |
|||
typeId = None |
|||
| ) |
Find an item with given attributes under fatherItem in the study.
If none is found, return None. If several items correspond to the parameters, only the first one is returned. The search is made only on given parameters (i.e. not None). To look explicitly for an empty attribute, use an empty string in the corresponding parameter.
See setItem() for the description of the parameters.
Find an item with given attributes under `fatherItem` in the study. If none is found, return :const:`None`. If several items correspond to the parameters, only the first one is returned. The search is made only on given parameters (i.e. not :const:`None`). To look explicitly for an empty attribute, use an empty string in the corresponding parameter. See :meth:`setItem` for the description of the parameters.
References studyedit.StudyEditor.getComment(), KERNEL_PY.kernel.studyedit.StudyEditor.getComment(), SALOME_PyNode.BigFileOnDiskBase.getFileName(), SALOME_PyNode.BigObjectOnDiskBase.getFileName(), studyedit.StudyEditor.getFileName(), KERNEL_PY.kernel.studyedit.StudyEditor.getFileName(), studyedit.StudyEditor.getFileType(), KERNEL_PY.kernel.studyedit.StudyEditor.getFileType(), studyedit.StudyEditor.getIcon(), KERNEL_PY.kernel.studyedit.StudyEditor.getIcon(), SALOME::ExternalServerHandler.getName(), Engines::ContainerScriptPerfLog.getName(), Engines::PyNodeBase.getName(), SALOME_ExternalServerHandler.getName(), SALOME_ContainerScriptPerfLog.getName(), SALOME_StudyEditor.getName(), SALOME_PyNode.PyNode_i.getName(), SALOME_PyNode.PyScriptNode_Abstract_i.getName(), KERNEL_PY.kernel.testdata.TestData.getName(), studyedit.StudyEditor.getName(), KERNEL_PY.kernel.studyedit.StudyEditor.getName(), studyedit.StudyEditor.getTypeId(), KERNEL_PY.kernel.studyedit.StudyEditor.getTypeId(), studyedit.StudyEditor.study(), and KERNEL_PY.kernel.studyedit.StudyEditor.study().
Referenced by studyedit.StudyEditor.findOrCreateItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.findOrCreateItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.findOrCreateComponent | ( | self, | |
| moduleName, | |||
componentName = None, |
|||
icon = None, |
|||
containerName = _DEFAULT_CONTAINER |
|||
| ) |
Find a component corresponding to the Salome module moduleName in the study.
If none is found, create a new component and associate it with the corresponding engine (i.e. the engine named moduleName). Note that in Salome 5, the module name and engine name must be identical (every module must provide an engine with the same name). In Salome 6 it will be possible to define a different name for the engine.
| moduleName | (string) name of the module corresponding to the component (the module name is the string value in the attribute "AttributeComment" of the component) |
| componentName | (string) name of the new component if created. If None, use moduleName instead. |
| icon | (string) icon for the new component (attribute "AttributePixMap"). |
| containerName | (string) name of the container in which the engine should be loaded. |
Find a component corresponding to the Salome module `moduleName` in
the study. If none is found, create a new component and associate it
with the corresponding engine (i.e. the engine named `moduleName`).
Note that in Salome 5, the module name and engine name must be
identical (every module must provide an engine with the same name).
In Salome 6 it will be possible to define a different name for the
engine.
:type moduleName: string
:param moduleName: name of the module corresponding to the component
(the module name is the string value in the
attribute "AttributeComment" of the component)
:type componentName: string
:param componentName: name of the new component if created. If
:const:`None`, use `moduleName` instead.
:type icon: string
:param icon: icon for the new component (attribute "AttributePixMap").
:type containerName: string
:param containerName: name of the container in which the engine should be
loaded.
:return: the SComponent found or created.
References studyedit.StudyEditor.builder(), KERNEL_PY.kernel.studyedit.StudyEditor.builder(), studyedit.StudyEditor.lcc(), KERNEL_PY.kernel.studyedit.StudyEditor.lcc(), LifeCycleCORBA_SWIGTest.LifeCycleCORBA_SWIGTest.lcc, SALOME_StudyEditor.setIcon(), studyedit.StudyEditor.setIcon(), KERNEL_PY.kernel.studyedit.StudyEditor.setIcon(), KERNEL_PY.salome_ComponentGUI.SetName(), studyedit.StudyEditor.study(), and KERNEL_PY.kernel.studyedit.StudyEditor.study().
| def KERNEL_PY.kernel.studyedit.StudyEditor.findOrCreateItem | ( | self, | |
| fatherItem, | |||
| name, | |||
fileType = None, |
|||
fileName = None, |
|||
comment = None, |
|||
icon = None, |
|||
IOR = None, |
|||
typeId = None |
|||
| ) |
Find an object under fatherItem in the study with the given attributes.
Return the first one found if at least one exists, otherwise create a new one with the given attributes and return it.
See setItem() for the description of the parameters.
Find an object under `fatherItem` in the study with the given attributes. Return the first one found if at least one exists, otherwise create a new one with the given attributes and return it. See :meth:`setItem` for the description of the parameters.
References studyedit.StudyEditor.createItem(), KERNEL_PY.kernel.studyedit.StudyEditor.createItem(), studyedit.StudyEditor.findItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.findItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.getAttributeValue | ( | self, | |
| sObject, | |||
| attributeName, | |||
default = None |
|||
| ) |
Return the value of the attribute named attributeName on the object sObject, or default if the attribute doesn't exist.
Return the value of the attribute named `attributeName` on the object `sObject`, or `default` if the attribute doesn't exist.
References studyedit.StudyEditor.builder(), and KERNEL_PY.kernel.studyedit.StudyEditor.builder().
Referenced by studyedit.StudyEditor.getFileName(), KERNEL_PY.kernel.studyedit.StudyEditor.getFileName(), studyedit.StudyEditor.getFileType(), KERNEL_PY.kernel.studyedit.StudyEditor.getFileType(), studyedit.StudyEditor.getTypeId(), and KERNEL_PY.kernel.studyedit.StudyEditor.getTypeId().
| def KERNEL_PY.kernel.studyedit.StudyEditor.getComment | ( | self, | |
| sObject | |||
| ) |
Return the comment of the object sObject.
Referenced by studyedit.StudyEditor.findItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.findItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.getFileName | ( | self, | |
| sObject | |||
| ) |
Return the value of the attribute "AttributeExternalFileDef" of the object sObject, or an empty string if it is not set.
Return the value of the attribute "AttributeExternalFileDef" of the object `sObject`, or an empty string if it is not set.
References studyedit.StudyEditor.getAttributeValue(), and KERNEL_PY.kernel.studyedit.StudyEditor.getAttributeValue().
Referenced by SALOME_PyNode.BigObjectOnDiskSequence.__getitem__(), studyedit.StudyEditor.findItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.findItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.getFileType | ( | self, | |
| sObject | |||
| ) |
Return the value of the attribute "AttributeFileType" of the object sObject, or an empty string if it is not set.
Return the value of the attribute "AttributeFileType" of the object `sObject`, or an empty string if it is not set.
References studyedit.StudyEditor.getAttributeValue(), and KERNEL_PY.kernel.studyedit.StudyEditor.getAttributeValue().
Referenced by studyedit.StudyEditor.findItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.findItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.getIcon | ( | self, | |
| sObject | |||
| ) |
Return the value of the attribute "AttributePixMap" of the object sObject, or an empty string if it is not set.
Return the value of the attribute "AttributePixMap" of the object `sObject`, or an empty string if it is not set.
References studyedit.StudyEditor.builder(), and KERNEL_PY.kernel.studyedit.StudyEditor.builder().
Referenced by studyedit.StudyEditor.findItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.findItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.getName | ( | self, | |
| sObject | |||
| ) |
Return the name of the object sObject.
Referenced by studyedit.StudyEditor.findItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.findItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.getOrLoadObject | ( | self, | |
| item | |||
| ) |
Get the CORBA object associated with the SObject item, eventually by first loading it with the corresponding engine.
Get the CORBA object associated with the SObject `item`, eventually by first loading it with the corresponding engine.
References studyedit.StudyEditor.loadComponentEngine(), and KERNEL_PY.kernel.studyedit.StudyEditor.loadComponentEngine().
| def KERNEL_PY.kernel.studyedit.StudyEditor.getTypeId | ( | self, | |
| sObject | |||
| ) |
Return the value of the attribute "AttributeLocalID" of the object sObject, or None if it is not set.
Return the value of the attribute "AttributeLocalID" of the object `sObject`, or :const:`None` if it is not set.
References studyedit.StudyEditor.getAttributeValue(), and KERNEL_PY.kernel.studyedit.StudyEditor.getAttributeValue().
Referenced by studyedit.StudyEditor.findItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.findItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.lcc | ( | self | ) |
Attribute that providess access to the SALOME life cycle CORBA service.
References salome.salome_init().
Referenced by studyedit.StudyEditor.findOrCreateComponent(), KERNEL_PY.kernel.studyedit.StudyEditor.findOrCreateComponent(), studyedit.StudyEditor.loadComponentEngine(), KERNEL_PY.kernel.studyedit.StudyEditor.loadComponentEngine(), LifeCycleCORBA_SWIGTest.LifeCycleCORBA_SWIGTest.test002_FindOrLoad_Component_SameInstance(), LifeCycleCORBA_SWIGTest.LifeCycleCORBA_SWIGTest.test003_FindOrLoad_Component_PythonInCppContainer(), LifeCycleCORBA_SWIGTest.LifeCycleCORBA_SWIGTest.test004_FindOrLoad_Component_PythonSameInstance(), LifeCycleCORBA_SWIGTest.LifeCycleCORBA_SWIGTest.test005_FindOrLoad_Component_UnknownInCatalog(), LifeCycleCORBA_SWIGTest.LifeCycleCORBA_SWIGTest.test006_FindOrLoad_Component_LaunchContainerHostname(), LifeCycleCORBA_SWIGTest.LifeCycleCORBA_SWIGTest.test007_FindOrLoad_Component_SameContainer(), and LifeCycleCORBA_SWIGTest.LifeCycleCORBA_SWIGTest.test008_FindOrLoad_Component_UnknownMachine().
| def KERNEL_PY.kernel.studyedit.StudyEditor.loadComponentEngine | ( | self, | |
| sComponent, | |||
containerName = _DEFAULT_CONTAINER |
|||
| ) |
Load the engine corresponding to sComponent in the container containerName, associate the engine with the component and load the CORBA objects of this component in the study.
Load the engine corresponding to `sComponent` in the container `containerName`, associate the engine with the component and load the CORBA objects of this component in the study.
References studyedit.StudyEditor.builder(), KERNEL_PY.kernel.studyedit.StudyEditor.builder(), studyedit.StudyEditor.lcc(), KERNEL_PY.kernel.studyedit.StudyEditor.lcc(), and LifeCycleCORBA_SWIGTest.LifeCycleCORBA_SWIGTest.lcc.
Referenced by studyedit.StudyEditor.getOrLoadObject(), and KERNEL_PY.kernel.studyedit.StudyEditor.getOrLoadObject().
| def KERNEL_PY.kernel.studyedit.StudyEditor.removeItem | ( | self, | |
| item, | |||
withChildren = False |
|||
| ) |
Remove the given item from the study.
Note that the items are never really deleted. They just don't appear in the study anymore.
| item | (SObject) the item to be removed |
| withChildren | (boolean) if True, also remove the children of item |
Remove the given item from the study. Note that the items are never
really deleted. They just don't appear in the study anymore.
:type item: SObject
:param item: the item to be removed
:type withChildren: boolean
:param withChildren: if :const:`True`, also remove the children of
`item`
:return: :const:`True` if the item was removed successfully, or
:const:`False` if an error happened.
References studyedit.StudyEditor.builder(), and KERNEL_PY.kernel.studyedit.StudyEditor.builder().
| def KERNEL_PY.kernel.studyedit.StudyEditor.setAttributeValue | ( | self, | |
| sObject, | |||
| attributeName, | |||
| attributeValue | |||
| ) |
Set the value of the attribute named attributeName on the object sObject to the value attributeValue.
Set the value of the attribute named `attributeName` on the object `sObject` to the value `attributeValue`.
References studyedit.StudyEditor.builder(), and KERNEL_PY.kernel.studyedit.StudyEditor.builder().
Referenced by studyedit.StudyEditor.setFileName(), KERNEL_PY.kernel.studyedit.StudyEditor.setFileName(), studyedit.StudyEditor.setFileType(), KERNEL_PY.kernel.studyedit.StudyEditor.setFileType(), studyedit.StudyEditor.setTypeId(), and KERNEL_PY.kernel.studyedit.StudyEditor.setTypeId().
| def KERNEL_PY.kernel.studyedit.StudyEditor.setComment | ( | self, | |
| sObject, | |||
| comment | |||
| ) |
Set the comment of the object sObject.
References studyedit.StudyEditor.builder(), and KERNEL_PY.kernel.studyedit.StudyEditor.builder().
Referenced by studyedit.StudyEditor.setItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.setItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.setFileName | ( | self, | |
| sObject, | |||
| value | |||
| ) |
Set the attribute "AttributeExternalFileDef" of the object sObject to the value value.
Set the attribute "AttributeExternalFileDef" of the object `sObject` to the value `value`.
References studyedit.StudyEditor.setAttributeValue(), and KERNEL_PY.kernel.studyedit.StudyEditor.setAttributeValue().
Referenced by studyedit.StudyEditor.setItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.setItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.setFileType | ( | self, | |
| sObject, | |||
| value | |||
| ) |
Set the attribute "AttributeFileType" of the object sObject to the value value.
Set the attribute "AttributeFileType" of the object `sObject` to the value `value`.
References studyedit.StudyEditor.setAttributeValue(), and KERNEL_PY.kernel.studyedit.StudyEditor.setAttributeValue().
Referenced by studyedit.StudyEditor.setItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.setItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.setIcon | ( | self, | |
| sObject, | |||
| value | |||
| ) |
Set the attribute "AttributePixMap" of the object sObject to the value value.
Set the attribute "AttributePixMap" of the object `sObject` to the value `value`.
References studyedit.StudyEditor.builder(), and KERNEL_PY.kernel.studyedit.StudyEditor.builder().
Referenced by studyedit.StudyEditor.findOrCreateComponent(), KERNEL_PY.kernel.studyedit.StudyEditor.findOrCreateComponent(), studyedit.StudyEditor.setItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.setItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.setItem | ( | self, | |
| item, | |||
name = None, |
|||
fileType = None, |
|||
fileName = None, |
|||
comment = None, |
|||
icon = None, |
|||
IOR = None, |
|||
typeId = None |
|||
| ) |
Modify the attributes of an item in the study.
Unspecified attributes (i.e. those set to None) are left unchanged.
| item | (SObject) item to modify. |
| name | (string or unicode) item name (attribute AttributeName). |
| fileType | (string or unicode) item file type (attribute AttributeFileType). |
| fileName | (string or unicode) item file name (attribute AttributeExternalFileDef). |
| comment | (string or unicode) item comment (attribute AttributeComment). Note that this attribute will appear in the Value column in the object browser. |
| icon | (string or unicode) item icon name (attribute AttributePixMap). |
| IOR | (string) IOR of a CORBA object associated with the item (attribute AttributeIOR). |
| typeId | (integer) item type (attribute AttributeLocalID). |
Modify the attributes of an item in the study. Unspecified attributes
(i.e. those set to :const:`None`) are left unchanged.
:type item: SObject
:param item: item to modify.
:type name: string or unicode
:param name: item name (attribute 'AttributeName').
:type fileType: string or unicode
:param fileType: item file type (attribute 'AttributeFileType').
:type fileName: string or unicode
:param fileName: item file name (attribute
'AttributeExternalFileDef').
:type comment: string or unicode
:param comment: item comment (attribute 'AttributeComment'). Note that
this attribute will appear in the 'Value' column in
the object browser.
:type icon: string or unicode
:param icon: item icon name (attribute 'AttributePixMap').
:type IOR: string
:param IOR: IOR of a CORBA object associated with the item
(attribute 'AttributeIOR').
:type typeId: integer
:param typeId: item type (attribute 'AttributeLocalID').
References studyedit.StudyEditor.builder(), KERNEL_PY.kernel.studyedit.StudyEditor.builder(), studyedit.StudyEditor.setComment(), KERNEL_PY.kernel.studyedit.StudyEditor.setComment(), SALOME_ContainerHelper.InOutputObjVisitorAbstract.setFileName(), SALOME_ContainerHelper.ObjMemModel.setFileName(), SALOME_ContainerHelper.FakeObjVisitor.setFileName(), studyedit.StudyEditor.setFileName(), KERNEL_PY.kernel.studyedit.StudyEditor.setFileName(), studyedit.StudyEditor.setFileType(), KERNEL_PY.kernel.studyedit.StudyEditor.setFileType(), SALOME_StudyEditor.setIcon(), studyedit.StudyEditor.setIcon(), KERNEL_PY.kernel.studyedit.StudyEditor.setIcon(), SALOME_ContainerScriptPerfLog.setName(), SALOMEDSImpl_GenericVariable.setName(), SALOME_StudyEditor.setName(), studyedit.StudyEditor.setName(), KERNEL_PY.kernel.studyedit.StudyEditor.setName(), KERNEL_PY.kernel.testdata.TestData.setName(), studyedit.StudyEditor.setTypeId(), and KERNEL_PY.kernel.studyedit.StudyEditor.setTypeId().
Referenced by studyedit.StudyEditor.createItem(), KERNEL_PY.kernel.studyedit.StudyEditor.createItem(), studyedit.StudyEditor.setItemAtTag(), and KERNEL_PY.kernel.studyedit.StudyEditor.setItemAtTag().
| def KERNEL_PY.kernel.studyedit.StudyEditor.setItemAtTag | ( | self, | |
| fatherItem, | |||
| tag, | |||
name = None, |
|||
fileType = None, |
|||
fileName = None, |
|||
comment = None, |
|||
icon = None, |
|||
IOR = None, |
|||
typeId = None |
|||
| ) |
Find an item tagged tag under fatherItem in the study tree or create it if there is none, then set its attributes.
| fatherItem | (SObject) item under which the tagged item will be looked for and eventually created. |
| tag | integer) tag of the item to look for. |
See setItem() for the description of the other parameters.
Find an item tagged `tag` under `fatherItem` in the study tree or
create it if there is none, then set its attributes.
:type fatherItem: SObject
:param fatherItem: item under which the tagged item will be looked for
and eventually created.
:type tag: integer
:param tag: tag of the item to look for.
:return: the SObject at `tag` if found or created successfully, or
:const:`None` if an error happened.
See :meth:`setItem` for the description of the other parameters.
References studyedit.StudyEditor.builder(), KERNEL_PY.kernel.studyedit.StudyEditor.builder(), studyedit.StudyEditor.setItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.setItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.setName | ( | self, | |
| sObject, | |||
| name | |||
| ) |
Set the name of the object sObject.
References studyedit.StudyEditor.builder(), KERNEL_PY.kernel.studyedit.StudyEditor.builder(), and KERNEL_PY.salome_ComponentGUI.SetName().
Referenced by studyedit.StudyEditor.setItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.setItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.setTypeId | ( | self, | |
| sObject, | |||
| value | |||
| ) |
Set the attribute "AttributeLocalID" of the object sObject to the value value.
Set the attribute "AttributeLocalID" of the object `sObject` to the value `value`.
References studyedit.StudyEditor.setAttributeValue(), and KERNEL_PY.kernel.studyedit.StudyEditor.setAttributeValue().
Referenced by studyedit.StudyEditor.setItem(), and KERNEL_PY.kernel.studyedit.StudyEditor.setItem().
| def KERNEL_PY.kernel.studyedit.StudyEditor.study | ( | self | ) |
Attribute that provides access to the study.
References salome.salome_init().
Referenced by studyedit.StudyEditor.createItem(), KERNEL_PY.kernel.studyedit.StudyEditor.createItem(), studyedit.StudyEditor.findItem(), KERNEL_PY.kernel.studyedit.StudyEditor.findItem(), studyedit.StudyEditor.findOrCreateComponent(), and KERNEL_PY.kernel.studyedit.StudyEditor.findOrCreateComponent().