From a21b679e83117622d86615406b12e73717b9294d Mon Sep 17 00:00:00 2001 From: rnv Date: Fri, 5 Dec 2008 15:34:05 +0000 Subject: [PATCH] Add comments. --- idl/SALOMEDS.idl | 44 +++++++++++++++++++++++++++++++++----------- 1 file changed, 33 insertions(+), 11 deletions(-) diff --git a/idl/SALOMEDS.idl b/idl/SALOMEDS.idl index c0a3aaae3..0473150de 100644 --- a/idl/SALOMEDS.idl +++ b/idl/SALOMEDS.idl @@ -431,53 +431,75 @@ during each working session. ListOfStrings GetLockerID(); /*! - TODO: Write comments. + Create real variable with Name theVarName value theValue + (or set if variable value in to theValue already exists) + \param theVarName is a name of the variable + \param theVarName is a value of the variable. */ void SetReal( in string theVarName, in double theValue ); -/*! - TODO: Write comments. +/*! + Create integer variable with Name theVarName value theValue + (or set if variable value in to theValue already exists) + \param theVarName is a name of the variable + \param theVarName is a value of the variable. */ void SetInteger( in string theVarName, in long theValue ); /*! - TODO: Write comments. + Create boolean variable with Name theVarName value theValue + (or set if variable value in to theValue already exists) + \param theVarName is a name of the variable + \param theVarName is a value of the variable. */ void SetBoolean( in string theVarName, in boolean theValue ); /*! - TODO: Write comments. + Return real value of the variable + \param theVarName is a name of the variable. */ double GetReal( in string theVarName ); + /*! - TODO: Write comments. + Return integer value of the variable + \param theVarName is a name of the variable. */ long GetInteger( in string theVarName ); /*! - TODO: Write comments. + Return boolean value of the variable + \param theVarName is a name of the variable. */ boolean GetBoolean( in string theVarName ); /*! - TODO: Write comments. + Return true if variable is real otherwise return false. + \param theVarName is a name of the variable. */ boolean IsReal( in string theVarName ); /*! - TODO: Write comments. + Return true if variable is integer otherwise return false. + \param theVarName is a name of the variable. */ boolean IsInteger( in string theVarName ); + /*! - TODO: Write comments. + Return true if variable is boolean otherwise return false. + \param theVarName is a name of the variable. */ boolean IsBoolean( in string theVarName ); /*! - TODO: Write comments. + Return true if variable exists in the study, + otherwise return false. + \param theVarName is a name of the variable. */ boolean IsVariable( in string theVarName ); +/*! + Return names of all variables from the study. +*/ ListOfStrings GetVariableNames(); /*! \brief Removing variable -- 2.39.2