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

Public Member Functions

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

Detailed Description

common editor interface variable

Constructor & Destructor Documentation

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

Creates a variable with the given information set.

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

Member Function Documentation

String Variable::GetComment ( )

Retrieves the comment associated with the variable.

Returns
String containing the comment
Since
GL Studio 6.0.1
String Variable::GetInitialValue ( )

Retrieves the variable's initial value.

Returns
String containing the initial value of the variable
String Variable::GetName ( )

Retrieves the variable's name.

Returns
String containing the name of the variable
String Variable::GetType ( )

Retrieves the variable's return type.

Returns
String containing the return type of the variable
void Variable::SetComment ( String  comment)

Sets the comment associated with the variable.

Parameters
commentString containing the comment for the variable
Since
GL Studio 6.0.1
void Variable::SetInitialValue ( String  initVal)

Sets the variable's initial value.

Parameters
initValNew initial value for the variable
void Variable::SetName ( String  name)

Sets the variable's name.

Parameters
nameNew name of variable
void Variable::SetType ( String  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: