Publishing results in SALOME study

Functions
def	addToStudyAuto
	Enable / disable results auto-publishing. More...
def	addToStudy
	Publish in study aShape with name aName. More...
def	addToStudyInFather
	Publish in study aShape with name aName as sub-object of previously published aFather. More...
def	NewFolder
	Creates a new folder object. More...
def	PutToFolder
	Move object to the specified folder. More...
def	PutListToFolder
	Move list of objects to the specified folder. More...

Detailed Description

Function Documentation

def 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

maxNbSubShapes

maximum number of sub-shapes allowed for publishing.

References geomBuilder.myMaxNbSubShapesAllowed.

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

Publish in study aShape with name aName.

Parameters

aShape	the shape to be published
aName	the name for the shape
doRestoreSubShapes	if True, finds and publishes also sub-shapes of aShape, corresponding to its arguments and published sub-shapes of arguments
theArgs,theFindMethod,theInheritFirstArg	see RestoreSubShapes() for these arguments description

Returns

study entry of the published shape in form of string

Example

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

def addToStudyInFather	(		self,
			aFather,
			aShape,
			aName
	)

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

Parameters

aFather	previously published object
aShape	the shape to be published as sub-object of aFather
aName	the name for the shape

Returns

study entry of the published shape in form of string

Example

References GEOM_Gen.AddInStudy(), and geomBuilder.myStudy.

def NewFolder	(		self,
			Name,
			Father = None
	)

Creates a new folder object.

It is a container for any GEOM objects.

Parameters

Name	name of the container
Father	parent object. If None, folder under 'Geometry' root object will be created.

Returns

a new created folder

References GEOM_Gen.CreateFolder(), and geomBuilder.father.

def PutToFolder	(		self,
			Object,
			Folder
	)

Move object to the specified folder.

Parameters

Object	object to move
Folder	target folder

References GEOM_Gen.MoveToFolder().

def PutListToFolder	(		self,
			ListOfSO,
			Folder
	)

Move list of objects to the specified folder.

Parameters

ListOfSO	list of objects to move
Folder	target folder

References geomBuilder.ManageTransactions(), and GEOM_Gen.MoveListToFolder().