Version: 9.8.0
study_exchange_vars
Collaboration diagram for study_exchange_vars:

Data Structures

class  study_exchange_vars.Variable
 This class describes a single variable. More...
 
class  study_exchange_vars.ExchangeVariables
 This class describes "Exchange Variables", i.e. More...
 
class  KERNEL_PY.kernel.parametric.study_exchange_vars.Variable
 This class describes a single variable. More...
 
class  KERNEL_PY.kernel.parametric.study_exchange_vars.ExchangeVariables
 This class describes "Exchange Variables", i.e. More...
 

Functions

def study_exchange_vars.createSObjectForExchangeVariables (fatherSobj, exchangeVariables, name=DEFAULT_NAME, icon=None, typeId=None)
 Create a SObject to store an ExchangeVariables instance. More...
 
def study_exchange_vars.updateSObjectForExchangeVariables (sobj, exchangeVariables, name=DEFAULT_NAME, icon=None, typeId=None)
 Update an existing SObject storing an ExchangeVariables instance. More...
 
def study_exchange_vars.getExchangeVariablesFromSObject (sobj)
 Get an ExchangeVariables instance from a SObject that stores it. More...
 
def study_exchange_vars.loadExchangeVariablesFromXmlFile (filepath)
 Load an ExchangeVariables instance from an XML file. More...
 
def KERNEL_PY.kernel.parametric.study_exchange_vars.createSObjectForExchangeVariables (fatherSobj, exchangeVariables, name=DEFAULT_NAME, icon=None, typeId=None)
 Create a SObject to store an ExchangeVariables instance. More...
 
def KERNEL_PY.kernel.parametric.study_exchange_vars.updateSObjectForExchangeVariables (sobj, exchangeVariables, name=DEFAULT_NAME, icon=None, typeId=None)
 Update an existing SObject storing an ExchangeVariables instance. More...
 
def KERNEL_PY.kernel.parametric.study_exchange_vars.getExchangeVariablesFromSObject (sobj)
 Get an ExchangeVariables instance from a SObject that stores it. More...
 
def KERNEL_PY.kernel.parametric.study_exchange_vars.loadExchangeVariablesFromXmlFile (filepath)
 Load an ExchangeVariables instance from an XML file. More...
 

Detailed Description

This module provides classes and functions to handle "Exchange Variables", i.e. description of variables to be exchanged between a supervision code and a computation code. These Exchange Variables can be stored in a SObject in Salome study.

Function Documentation

◆ createSObjectForExchangeVariables() [1/2]

def study_exchange_vars.createSObjectForExchangeVariables (   fatherSobj,
  exchangeVariables,
  name = DEFAULT_NAME,
  icon = None,
  typeId = None 
)

Create a SObject to store an ExchangeVariables instance.

Parameters
fatherSobj(SObject) parent of the SObject to create.
exchangeVariables(ExchangeVariables) ExchangeVariables instance to store in Salome study.
name(string) name of the SObject to create.
icon(string) icon of the SObject to create.
typeId(integer) type of the SObject to create.
Returns
the newly created SObject.

References study_exchange_vars._setSObjectForExchangeVariables(), studyedit.getStudyEditor(), and study_exchange_vars.updateSObjectForExchangeVariables().

Referenced by study_exchange_vars.ExchangeVariables.saveToXmlFile().

◆ createSObjectForExchangeVariables() [2/2]

def KERNEL_PY.kernel.parametric.study_exchange_vars.createSObjectForExchangeVariables (   fatherSobj,
  exchangeVariables,
  name = DEFAULT_NAME,
  icon = None,
  typeId = None 
)

Create a SObject to store an ExchangeVariables instance.

Parameters
fatherSobj(SObject) parent of the SObject to create.
exchangeVariables(ExchangeVariables) ExchangeVariables instance to store in Salome study.
name(string) name of the SObject to create.
icon(string) icon of the SObject to create.
typeId(integer) type of the SObject to create.
Returns
the newly created SObject.
Create a SObject to store an :class:`ExchangeVariables` instance.

:type  fatherSobj: SObject
:param fatherSobj: parent of the SObject to create.

:type  exchangeVariables: :class:`ExchangeVariables`
:param exchangeVariables: :class:`ExchangeVariables` instance to store in
                          Salome study.

:type  name: string
:param name: name of the SObject to create.

:type  icon: string
:param icon: icon of the SObject to create.

:type  typeId: integer
:param typeId: type of the SObject to create.

:return: the newly created SObject.

References KERNEL_PY.kernel.parametric.study_exchange_vars._setSObjectForExchangeVariables(), studyedit.getStudyEditor(), and KERNEL_PY.kernel.parametric.study_exchange_vars.updateSObjectForExchangeVariables().

Referenced by KERNEL_PY.kernel.parametric.study_exchange_vars.ExchangeVariables.saveToXmlFile().

◆ getExchangeVariablesFromSObject() [1/2]

def study_exchange_vars.getExchangeVariablesFromSObject (   sobj)

Get an ExchangeVariables instance from a SObject that stores it.

Parameters
sobj(SObject) the SObject from which to read the ExchangeVariables instance.
Returns
the newly created ExchangeVariables instance.

◆ getExchangeVariablesFromSObject() [2/2]

def KERNEL_PY.kernel.parametric.study_exchange_vars.getExchangeVariablesFromSObject (   sobj)

Get an ExchangeVariables instance from a SObject that stores it.

Parameters
sobj(SObject) the SObject from which to read the ExchangeVariables instance.
Returns
the newly created ExchangeVariables instance.
Get an :class:`ExchangeVariables` instance from a SObject that stores it.

:type  sobj: SObject
:param sobj: the SObject from which to read the :class:`ExchangeVariables`
             instance.

:return: the newly created :class:`ExchangeVariables` instance.

◆ loadExchangeVariablesFromXmlFile() [1/2]

def study_exchange_vars.loadExchangeVariablesFromXmlFile (   filepath)

Load an ExchangeVariables instance from an XML file.

Parameters
filepath(string) path of the XML file to load.
Returns
the newly created ExchangeVariables instance.

◆ loadExchangeVariablesFromXmlFile() [2/2]

def KERNEL_PY.kernel.parametric.study_exchange_vars.loadExchangeVariablesFromXmlFile (   filepath)

Load an ExchangeVariables instance from an XML file.

Parameters
filepath(string) path of the XML file to load.
Returns
the newly created ExchangeVariables instance.
Load an :class:`ExchangeVariables` instance from an XML file.

:type  filepath: string
:param filepath: path of the XML file to load.

:return: the newly created :class:`ExchangeVariables` instance.

◆ updateSObjectForExchangeVariables() [1/2]

def study_exchange_vars.updateSObjectForExchangeVariables (   sobj,
  exchangeVariables,
  name = DEFAULT_NAME,
  icon = None,
  typeId = None 
)

Update an existing SObject storing an ExchangeVariables instance.

Parameters
sobj(SObject) the SObject to update.

See createSObjectForExchangeVariables() for the description of the other parameters.

References study_exchange_vars._setSObjectForExchangeVariables(), and studyedit.getStudyEditor().

Referenced by study_exchange_vars.createSObjectForExchangeVariables().

◆ updateSObjectForExchangeVariables() [2/2]

def KERNEL_PY.kernel.parametric.study_exchange_vars.updateSObjectForExchangeVariables (   sobj,
  exchangeVariables,
  name = DEFAULT_NAME,
  icon = None,
  typeId = None 
)

Update an existing SObject storing an ExchangeVariables instance.

Parameters
sobj(SObject) the SObject to update.

See createSObjectForExchangeVariables() for the description of the other parameters.

Update an existing SObject storing an :class:`ExchangeVariables` instance.

:type  sobj: SObject
:param sobj: the SObject to update.

See :func:`createSObjectForExchangeVariables` for the description of the
other parameters.

References KERNEL_PY.kernel.parametric.study_exchange_vars._setSObjectForExchangeVariables(), and studyedit.getStudyEditor().

Referenced by KERNEL_PY.kernel.parametric.study_exchange_vars.createSObjectForExchangeVariables().