Python Script Engine  8.3
GL Studio Editor Python Script API
Variable Class Reference

Public Member Functions

 Variable (str name, str type, str initVal, str comment=str())
 
str GetName ()
 
None SetName (str name)
 
str GetType ()
 
None SetType (str type)
 
str GetInitialValue ()
 
None SetInitialValue (str initVal)
 
str GetComment ()
 
None SetComment (str comment)
 

Detailed Description

common editor interface variable

Constructor & Destructor Documentation

◆ Variable()

Variable::Variable ( str  name,
str  type,
str  initVal,
str  comment = str() 
)

Creates a variable with the given information set.

Parameters
nameName of new variable
typeReturn type of new variable
initValInitial value for the new variable
commentstr comment regarding the new variable
Since
comment parameter new in GL Studio 6.0.1

Member Function Documentation

◆ GetComment()

str Variable::GetComment ( )

Retrieves the comment associated with the variable.

Returns
str containing the comment
Since
GL Studio 6.0.1

◆ GetInitialValue()

str Variable::GetInitialValue ( )

Retrieves the variable's initial value.

Returns
str containing the initial value of the variable

◆ GetName()

str Variable::GetName ( )

Retrieves the variable's name.

Returns
str containing the name of the variable

◆ GetType()

str Variable::GetType ( )

Retrieves the variable's return type.

Returns
str containing the return type of the variable

◆ SetComment()

None Variable::SetComment ( str  comment)

Sets the comment associated with the variable.

Parameters
commentstr containing the comment for the variable
Since
GL Studio 6.0.1

◆ SetInitialValue()

None Variable::SetInitialValue ( str  initVal)

Sets the variable's initial value.

Parameters
initValNew initial value for the variable

◆ SetName()

None Variable::SetName ( str  name)

Sets the variable's name.

Parameters
nameNew name of variable

◆ SetType()

None Variable::SetType ( str  type)

Sets the variable's return type.

Parameters
typeNew return type for the variable

The documentation for this class was generated from the following file: