WhileStatement
Overview
Cirrus class for a "while" loop statement. While loops first check the condition, if it's true, it will execute the body and evaluate the condition again to check if it should run again.
Location
- Reference: RemObjects.Elements.Cirrus.dll
- Namespace: RemObjects.Elements.Cirrus.Statements
- Ancestry: Statement | WhileStatement
constructor
Initializes an empty while statement
Initializes an empty while statement
constructor(aCondition: Value; aBody: Statement)
WhileStatement(Value aCondition, Statement aBody)
init(_ aCondition: Value, _ aBody: Statement)
WhileStatement(Value aCondition, Statement aBody)
Sub New(aCondition As Value, aBody As Statement)
Parameters:
- aCondition: While condition
- aBody: Body for this while block
Body
Body for this statement
property Body: Statement read write;
Statement Body { get; set; }
var Body: Statement { get{} set{} }
Statement Body { __get; __set; }
Property Body() As Statement
BuildStatement
Converts a statement to a string.
method BuildStatement(anIndent: Int32; sb: StringBuilder)
void BuildStatement(Int32 anIndent, StringBuilder sb)
func BuildStatement(_ anIndent: Int32, _ sb: StringBuilder)
void BuildStatement(Int32 anIndent, StringBuilder sb)
Sub BuildStatement(anIndent As Int32, sb As StringBuilder)
Parameters:
- anIndent: The nr of spaces to place before the start of this statement.
- sb: Output string builder.
Condition
While condition
property Condition: Value read write;
Value Condition { get; set; }
var Condition: Value { get{} set{} }
Value Condition { __get; __set; }
Property Condition() As Value
Kind
Returns what kind of statement this is; this can be used to find out if a statement is of a specific type without having to check all possible casts
property Kind: StatementKind read;
StatementKind Kind { get; }
var Kind: StatementKind { get{} }
StatementKind Kind { __get; }
ReadOnly Property Kind() As StatementKind
OverflowCheck (declared in Statement)
Overflow checking for binary and unary operations in this statement
property OverflowCheck: Boolean read write;
Boolean OverflowCheck { get; set; }
var OverflowCheck: Boolean { get{} set{} }
Boolean OverflowCheck { __get; __set; }
Property OverflowCheck() As Boolean
Position (declared in Statement)
Position this statement is defined at
property Position: IPosition read write;
IPosition Position { get; set; }
var Position: IPosition { get{} set{} }
IPosition Position { __get; __set; }
Property Position() As IPosition
SetOverflowCheckRecursive
Recursively sets the OverflowCheck flag
method SetOverflowCheckRecursive(value: Boolean)
void SetOverflowCheckRecursive(Boolean value)
func SetOverflowCheckRecursive(_ value: Boolean)
void SetOverflowCheckRecursive(Boolean value)
Sub SetOverflowCheckRecursive(value As Boolean)
Parameters:
- value: new value
ToString (declared in Statement)
Returns this statement as a string
method ToString: String
String ToString()
func ToString() -> String
String ToString()
Function ToString() As String
ToValue
Converts this statement to a value tree that creates these statements
method ToValue(aServicesParameter: Value; aServices: IServices): Value
Value ToValue(Value aServicesParameter, IServices aServices)
func ToValue(_ aServicesParameter: Value, _ aServices: IServices) -> Value
Value ToValue(Value aServicesParameter, IServices aServices)
Function ToValue(aServicesParameter As Value, aServices As IServices) As Value
Parameters:
- aServicesParameter: the value that contains where aServices is stored
- aServices: Actual services instance.
Body
Body for this statement
property Body: Statement read write;
Statement Body { get; set; }
var Body: Statement { get{} set{} }
Statement Body { __get; __set; }
Property Body() As Statement
Condition
While condition
property Condition: Value read write;
Value Condition { get; set; }
var Condition: Value { get{} set{} }
Value Condition { __get; __set; }
Property Condition() As Value
Kind
Returns what kind of statement this is; this can be used to find out if a statement is of a specific type without having to check all possible casts
property Kind: StatementKind read;
StatementKind Kind { get; }
var Kind: StatementKind { get{} }
StatementKind Kind { __get; }
ReadOnly Property Kind() As StatementKind
OverflowCheck (declared in Statement)
Overflow checking for binary and unary operations in this statement
property OverflowCheck: Boolean read write;
Boolean OverflowCheck { get; set; }
var OverflowCheck: Boolean { get{} set{} }
Boolean OverflowCheck { __get; __set; }
Property OverflowCheck() As Boolean
Position (declared in Statement)
Position this statement is defined at
constructor
Initializes an empty while statement
Initializes an empty while statement
constructor(aCondition: Value; aBody: Statement)
WhileStatement(Value aCondition, Statement aBody)
init(_ aCondition: Value, _ aBody: Statement)
WhileStatement(Value aCondition, Statement aBody)
Sub New(aCondition As Value, aBody As Statement)
Parameters:
- aCondition: While condition
- aBody: Body for this while block
BuildStatement
Converts a statement to a string.
method BuildStatement(anIndent: Int32; sb: StringBuilder)
void BuildStatement(Int32 anIndent, StringBuilder sb)
func BuildStatement(_ anIndent: Int32, _ sb: StringBuilder)
void BuildStatement(Int32 anIndent, StringBuilder sb)
Sub BuildStatement(anIndent As Int32, sb As StringBuilder)
Parameters:
- anIndent: The nr of spaces to place before the start of this statement.
- sb: Output string builder.
SetOverflowCheckRecursive
Recursively sets the OverflowCheck flag
method SetOverflowCheckRecursive(value: Boolean)
void SetOverflowCheckRecursive(Boolean value)
func SetOverflowCheckRecursive(_ value: Boolean)
void SetOverflowCheckRecursive(Boolean value)
Sub SetOverflowCheckRecursive(value As Boolean)
Parameters:
- value: new value
ToString (declared in Statement)
Returns this statement as a string
method ToString: String
String ToString()
func ToString() -> String
String ToString()
Function ToString() As String
ToValue
Converts this statement to a value tree that creates these statements
method ToValue(aServicesParameter: Value; aServices: IServices): Value
Value ToValue(Value aServicesParameter, IServices aServices)
func ToValue(_ aServicesParameter: Value, _ aServices: IServices) -> Value
Value ToValue(Value aServicesParameter, IServices aServices)
Function ToValue(aServicesParameter As Value, aServices As IServices) As Value
Parameters:
- aServicesParameter: the value that contains where aServices is stored
- aServices: Actual services instance.