Version: 9.16.0
Home
Loading...
Searching...
No Matches
Publishing results in SALOME study

Functions

 addToStudyAuto (self, maxNbSubShapes=-1)
 Enable / disable results auto-publishing.
 
 addToStudy (self, aShape, aName, doRestoreSubShapes=False, theArgs=[], theFindMethod=GEOM.FSM_GetInPlace, theInheritFirstArg=False)
 Publish in study aShape with name aName.
 
 addToStudyInFather (self, aFather, aShape, aName)
 Publish in study aShape with name aName as sub-object of previously published aFather.
 
 NewFolder (self, Name, Father=None)
 Creates a new folder object.
 
 PutToFolder (self, Object, Folder)
 Move object to the specified folder.
 
 PutListToFolder (self, ListOfSO, Folder)
 Move list of objects to the specified folder.
 

Detailed Description

Function Documentation

◆ addToStudyAuto()

addToStudyAuto (   self,
  maxNbSubShapes = -1 
)

Enable / disable results auto-publishing.

The automatic publishing is managed in the following way:

  • if maxNbSubShapes = 0, automatic publishing is disabled.
  • if maxNbSubShapes = -1 (default), automatic publishing is enabled and maximum number of sub-shapes allowed for publishing is unlimited; any negative value passed as parameter has the same effect.
  • if maxNbSubShapes is any positive value, automatic publishing is enabled and maximum number of sub-shapes allowed for publishing is set to specified value.
Parameters
maxNbSubShapesmaximum number of sub-shapes allowed for publishing.

References geomBuilder.myMaxNbSubShapesAllowed.

◆ addToStudy()

addToStudy (   self,
  aShape,
  aName,
  doRestoreSubShapes = False,
  theArgs = [],
  theFindMethod = GEOM.FSM_GetInPlace,
  theInheritFirstArg = False 
)

Publish in study aShape with name aName.

Parameters
aShapethe shape to be published
aNamethe name for the shape
doRestoreSubShapesif True, finds and publishes also sub-shapes of aShape, corresponding to its arguments and published sub-shapes of arguments
theArgs,theFindMethod,theInheritFirstArgsee RestoreSubShapes() for these arguments description
Returns
study entry of the published shape in form of string

Example

References GEOM_Gen.AddInStudy(), and GEOM_Gen.RestoreSubShapesSO().

◆ addToStudyInFather()

addToStudyInFather (   self,
  aFather,
  aShape,
  aName 
)

Publish in study aShape with name aName as sub-object of previously published aFather.

Parameters
aFatherpreviously published object
aShapethe shape to be published as sub-object of aFather
aNamethe name for the shape
Returns
study entry of the published shape in form of string

Example

References GEOM_Gen.AddInStudy().

◆ NewFolder()

NewFolder (   self,
  Name,
  Father = None 
)

Creates a new folder object.

It is a container for any GEOM objects.

Parameters
Namename of the container
Fatherparent object. If None, folder under 'Geometry' root object will be created.
Returns
a new created folder

References GEOM_Gen.CreateFolder().

◆ PutToFolder()

PutToFolder (   self,
  Object,
  Folder 
)

Move object to the specified folder.

Parameters
Objectobject to move
Foldertarget folder

References GEOM_Gen.MoveToFolder().

◆ PutListToFolder()

PutListToFolder (   self,
  ListOfSO,
  Folder 
)

Move list of objects to the specified folder.

Parameters
ListOfSOlist of objects to move
Foldertarget folder

References GEOM_Gen.MoveListToFolder().