Programming Reference:LabelIndex Class - Revision history

Mellinger: /* Operators */

2008-10-14T16:25:29Z

Operators

← Older revision		Revision as of 16:25, 14 October 2008
Line 28:		Line 28:
	int idx = Parameter( "MyParameter" ).RowLabels()["SecondRow"];		int idx = Parameter( "MyParameter" ).RowLabels()["SecondRow"];
	will return 1 if "SecondRow" exists as a string, and refers to the parameter's second row.		will return 1 if "SecondRow" exists as a string, and refers to the parameter's second row.
	For nonexistent labels, an index of zero will be returned.		For nonexistent labels, an index of zero will be returned, i.e. a nonexistent label will be mapped to the first entry.

	In the second case, specifying a zero-based index will provide access to the string label associated with that index:		In the second case, specifying a zero-based index will provide access to the string label associated with that index:

Mellinger: /* WriteToStream(ostream), ReadFromStream(istream) */

2008-10-14T16:23:18Z

WriteToStream(ostream), ReadFromStream(istream)

← Older revision		Revision as of 16:23, 14 October 2008
Line 14:		Line 14:
	===Resize(Size)===		===Resize(Size)===
	Adapts index size to the specified number of entries.		Adapts index size to the specified number of entries.
	==WriteToStream(ostream), ReadFromStream(istream)==		===WriteToStream(ostream), ReadFromStream(istream)===
	Writes/reads the index object from/to the specified stream. Stream representation is human readable, and corresponds to the way indices are specified in a [[Technical Reference:Parameter Definition\|parameter line]]. Beginning with an opening bracket, indices are listed in sequence, separated with space characters. Brackets and whitespace that are part of labels are encoded as described [[Technical_Reference:Parameter_Definition#Special_Characters\|here]].		Writes/reads the index object from/to the specified stream. Stream representation is human readable, and corresponds to the way indices are specified in a [[Technical Reference:Parameter Definition\|parameter line]]. Beginning with an opening bracket, indices are listed in sequence, separated with space characters. Brackets and whitespace that are part of labels are encoded as described [[Technical_Reference:Parameter_Definition#Special_Characters\|here]].

	==Properties==		==Properties==
	===bool IsTrivial (r)===		===bool IsTrivial (r)===

Mellinger at 09:11, 15 September 2008

2008-09-15T09:11:53Z

← Older revision		Revision as of 09:11, 15 September 2008
Line 3:		Line 3:

	==Synopsis==		==Synopsis==
	An object of type <tt>LabelIndex</tt> represents a mapping of string labels to array indices. Such string label indices are used in [[Technical_Reference:Parameter_Definition\|parameters]] and [[Programming Reference:\|signals]].		An object of type <tt>LabelIndex</tt> represents a mapping of string labels to array indices. Such string label indices are used in [[Technical_Reference:Parameter_Definition\|parameters]] and [[Programming Reference:Signals\|signals]].

	==Methods==		==Methods==
Line 34:		Line 34:

	==See also==		==See also==
	[[Technical Reference:Parameter Definition]], [[Programming Reference:Signals]]., [[Programming Reference:PhysicalUnit Class]]		[[Technical Reference:Parameter Definition]], [[Programming Reference:Signals]], [[Programming Reference:PhysicalUnit Class]]

	[[Category:Framework API]][[Category:Development]]		[[Category:Framework API]][[Category:Development]]

Mellinger at 09:11, 15 September 2008

2008-09-15T09:11:24Z

New page

==Location==
<tt>src/shared/types</tt>

==Synopsis==
An object of type <tt>LabelIndex</tt> represents a mapping of string labels to array indices. Such string label indices are used in [[Technical_Reference:Parameter_Definition|parameters]] and [[Programming Reference:|signals]].

==Methods==
===LabelIndex()===
Initializes the <tt>LabelIndex</tt> object to a "trivial" index, i.e. labels are initialized to one-based numerical indices "1", "2", "3", ...
===bool Exists(string Label)===
Returns ''true'' if the specified label exists in the index, ''false'' otherwise.
===Clear()===
Resets the index to a trivial index.
===Resize(Size)===
Adapts index size to the specified number of entries.
==WriteToStream(ostream), ReadFromStream(istream)==
Writes/reads the index object from/to the specified stream. Stream representation is human readable, and corresponds to the way indices are specified in a [[Technical Reference:Parameter Definition|parameter line]]. Beginning with an opening bracket, indices are listed in sequence, separated with space characters. Brackets and whitespace that are part of labels are encoded as described [[Technical_Reference:Parameter_Definition#Special_Characters|here]].
==Properties==
===bool IsTrivial (r)===
''True'' if all labels match string representations of one-based indices "1", "2", "3", ...
===int Size (r)===
The number of entries in the index, i.e. the number of indices that can be addressed by string labels.
==Operators==
The subscript operator [] may be applied to a <tt>LabelIndex</tt> object with a ''string'' or a ''numerical'' argument.

In the first case, the zero-based index corresponding to the specified label will be returned, as in the following example:
int idx = Parameter( "MyParameter" ).RowLabels()["SecondRow"];
will return 1 if "SecondRow" exists as a string, and refers to the parameter's second row.
For nonexistent labels, an index of zero will be returned.

In the second case, specifying a zero-based index will provide access to the string label associated with that index:
string label = Parameter( "MyParameter" ).RowLabels()[1];
will return "SecondRow" if this is the label specified for the second entry.

==See also==
[[Technical Reference:Parameter Definition]], [[Programming Reference:Signals]]., [[Programming Reference:PhysicalUnit Class]]

[[Category:Framework API]][[Category:Development]]