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...

Functions
def	study_exchange_vars.createSObjectForExchangeVariables
	Create a SObject to store an ExchangeVariables instance. More...
def	study_exchange_vars.updateSObjectForExchangeVariables
	Update an existing SObject storing an ExchangeVariables instance. More...
def	study_exchange_vars.getExchangeVariablesFromSObject
	Get an ExchangeVariables instance from a SObject that stores it. More...
def	study_exchange_vars.loadExchangeVariablesFromXmlFile
	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

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.

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.

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.

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.