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

name	Name of new variable
type	Return type of new variable
initVal	Initial value for the new variable
comment	str 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

comment

str 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

initVal

New initial value for the variable

SetName()

None Variable::SetName

(

str

name

)

Sets the variable's name.

Parameters

name	New name of variable

SetType()

None Variable::SetType

(

str

type

)

Sets the variable's return type.

Parameters

type	New return type for the variable

---

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

• Variable.i