Engines::PyNode Interface Reference

import"SALOME_PyNode.idl";

Inheritance diagram for Engines::PyNode:

Public Member Functions
pickledArgs	execute (in string functionName, in pickledArgs inargs) raises (SALOME::SALOME_Exception)
	execute a python function defined in the node More...
Container	getContainer ()
string	getCode ()
string	getName ()
void	defineNewCustomVar (in string varName, in pickledArgs valueOfVar) raises (SALOME::SALOME_Exception)
	This method allows to define a new global var called varName. More...
void	executeAnotherPieceOfCode (in string codeStr) raises (SALOME::SALOME_Exception)
	This method executes the python code in codeStr and can append/remove symboles in context to make them available or not for future call of execute on this. More...
void	Register ()
	Increase the reference count (mark as used by another object). More...
void	UnRegister ()
	Decrease the reference count (release by another object). More...
void	Destroy ()
	Obsolete, left for compatibility reasons only. More...

Member Function Documentation

defineNewCustomVar()

void Engines::PyNodeBase::defineNewCustomVar ( in string  varName, in pickledArgs  valueOfVar  ) raises ( SALOME::SALOME_Exception )

inherited

This method allows to define a new global var called varName.

This newly created var will be set to value valueOfVar.

Destroy()

void SALOME::GenericObj::Destroy ( )

inherited

Obsolete, left for compatibility reasons only.

Use UnRegister() instead.

execute()

pickledArgs Engines::PyNode::execute	(	in string	functionName,
		in pickledArgs	inargs
	)
raises	(	SALOME::SALOME_Exception
	)

execute a python function defined in the node

Parameters

functionName	the python function defined in the node to execute
inargs	input argument values (tuple,dict) provided as a python pickle

Returns

output argument values (tuple) as a python pickle

Referenced by KERNEL_PY.salome_pynode.SmartPyNode::__getattr__().

executeAnotherPieceOfCode()

void Engines::PyNodeBase::executeAnotherPieceOfCode ( in string  codeStr ) raises ( SALOME::SALOME_Exception )

inherited

This method executes the python code in codeStr and can append/remove symboles in context to make them available or not for future call of execute on this.

Parameters

[in]

codeStr

- the python code (without statement) to be executed, that can modify the context initialized at initialization.

getCode()

string Engines::PyNodeBase::getCode ( )

inherited

getContainer()

Container Engines::PyNodeBase::getContainer ( )

inherited

Referenced by testcontainer.TestResourceManager::test1(), testcontainer.TestResourceManager::test2(), testcontainer.TestResourceManager::test3(), and testcontainer.TestResourceManager::test4().

getName()

string Engines::PyNodeBase::getName ( )

inherited

Referenced by studyedit.StudyEditor::findItem(), and KERNEL_PY.kernel.studyedit.StudyEditor::findItem().

Register()

void SALOME::GenericObj::Register ( )

inherited

Increase the reference count (mark as used by another object).

UnRegister()

void SALOME::GenericObj::UnRegister ( )

inherited

Decrease the reference count (release by another object).

Referenced by SALOME_PyNode.Generic::Destroy().