FindStringInArrayCore

Synopsis

Find a string in a given array and return the array position.

---

module FindStringInArrayCore <src_file="mod_fsa.cxx">
{
	int active<NEportLevels={2,0}>;
	int ignore_whitespace<NEportLevels={2,0}>;
	string search_string<NEportLevels={2,0}>;
	string strings<NEportLevels={2,0}>[];
	int selectedItem<NEportLevels={0,2}>;
	cxxmethod+notify_inst+req update
	(
		active+read+req,
		ignore_whitespace+read+req,
		search_string+read+write+notify+req,
		strings+read+write+notify+req,
		selectedItem+write
	);
};

---

Description

FindStringInArrayCore references the given array of strings and iterates through it looking for a match to the search string. If Ignore White Spaces is enabled, any padding at the start or end of either the Search string or Array string is ignored.

Inputs

active

Allows the user of this module to disable its functionality.

ignore_whitespace

If this value is set thr module ignores any whitespaces at the beginning and end of the searchstring and array values.

search_string

References the search_string value of type string via the parameter block.

strings[]

Reference to the external string array.

Outputs

selectedItem

The output value selectedItem of type integer specifies the array index which matches the given search string.

Files

iac_proj/fstrarr/fsa_mods.v contains the Params group and the modFindStringInArray module V definitions.

Other Notes

The low-level library FindStringInArrayMods containing the module FindStringInArrayCore does not specify a process. By default the express process will be used.

Authors

Brian Selle, Leon Thrane
Advanced Visual Systems, Inc.

Modifications

Jon P. Davies
Manchester Visualization Centre

Contact

International AVS Centre
Manchester Visualization Centre
Manchester Computing
University of Manchester
Oxford Road
Manchester
UK
M13 9PL

See Also

FindStringInArray.