functionscanBoolean

Scan for the next Boolean number and trigger an assert if not present

Extends from Modelica.Icons.Function (Icon for functions).

Information

Syntax

             number = Strings.scanBoolean(string);
(number, nextIndex) = Strings.scanBoolean(string, startIndex=1, message="");

Description

Function scanBoolean scans the string starting at index "startIndex", checks whether the next token is a Boolean literal (i.e., is either the string "false" or "true", if converted to lower case letters) and returns its value as a Boolean number, as well as the index directly after the Boolean number. An assert is triggered, if the scanned string does not contain a Boolean literal with optional leading white space.

Inputs

Type	Name	Default	Description
String	string		String to be scanned
Integer	startIndex	1	Start scanning of string at character startIndex
String	message	""	Message used in error message if scan is not successful

Outputs

Type	Name	Default	Description
Boolean	number		Value of Boolean
Integer	nextIndex		Index of character after the found number