ReadArray

file,-folder-and-read-functions ReadArray

syntax

• ReadArray(source, domainunit, valuetype, startposition, decimal-seperatorflag)

definition

ReadArray(source, domainunit, valuetype, startposition, decimal-seperatorflag) results in an attribute, with row(s) of values, read from the source argument.

The second domainunit configures the domain-unit of the resulting attribute.

The third argument valuetype configures the value-type of the resulting attribute.

The fourth argument startposition configures the read position in the source. Spaces/tabs are used as delimiter.

The numbering of the positions is counted from left to right, meaning position two is the position of the second character in the first row.

The ReadArray function also generates a uint32 parameter subitem, called ReadPos. This parameter indicates the position of the next value after the value being read by the ReadArray function, see the example.

description

The ReadArray function is used to read a specific row from a text file, like an ini file.

Use the readvalue function to read specific values from a text file.

applies to

• parameter source with string value type
• unit domainunit with value type from group CanBeDomainUnit
• valuetype can be any value type
• parameter startposition with uint32 value type
• decimal-separator, an optional additional uint32 parameter or literal with two possible values:
  • 0 (default value): indicates a point is interpreted as decimal seperator
  • 1: indicates a comma is interpreted as decimal seperator.

example

container ReadArray
{
   parameter<string> file:  StorageName = "%projDir%/data/text.txt",  StorageType = "str";

   unit<uint32> HDomain: nrofrows = 4;
   unit<uint32> BDomain: nrofrows = 6;

   attribute<string> Header   (HDomain) := ReadArray(File, HDomain, string, 0);
   attribute<string> BodyRow1 (BDomain) := ReadArray(File, BDomain, string, Header/ReadPos);
};

text.txt

HDomain, nr of rows = 4

BDomain, nr of rows = 6

see also

• readvalue
• readelems
• readlines