Transformer Pipeline Module API Reference  8.0.2.290852-a608fcd3
Set class

Detailed Description

A simple set class that contains a number of distinct string elements.

Modules

 Relationship class
 The empty set.
 

Functions

Set new (var copy)
 The Set ructor (can be used as a copy ructor) More...
 
Set clear ()
 Removes all elements from the set. More...
 
Set add (var value)
 Add an element to a set. More...
 
Set remove (var value)
 Remove an element from a set. If the element is not in the set, then this method does nothing. More...
 
 Set.union (var set1, var set2)
 Creates a union of two existing sets. More...
 
Set isMember (var value)
 Tests for existence of an element in a set. More...
 
Set getValues ()
 Returns a reference to the element array used by the set (unsafe) More...
 
Set getSize ()
 Returns the number of elements in the set. More...
 
Set toString ()
 Converts a set to a string representation. More...
 
 Set.fromString (var str)
 Converts a string back to a set (the complement of toString()) More...
 

Function Documentation

Set add ( var  value)

Add an element to a set.

Parameters
valuethe element to add (must be a string)
Grid clear ( )

Removes all elements from the set.

Removes all relations.

Set getSize ( )

Returns the number of elements in the set.

Returns
the number of elements in the set
Set getValues ( )

Returns a reference to the element array used by the set (unsafe)

Returns
a reference to the element array used by the set (unsafe)
Set isMember ( var  value)

Tests for existence of an element in a set.

Parameters
valuethe element to test
Returns
true if the value is in the set, or false otherwise
Set new ( var  copy)

The Set ructor (can be used as a copy ructor)

Parameters
copyan exisiting set to make a copy of
Returns
a new instance of Set
Set remove ( var  value)

Remove an element from a set. If the element is not in the set, then this method does nothing.

Parameters
valuethe element to remove (must be a string)
Set.fromString ( var  str)

Converts a string back to a set (the complement of toString())

Returns
a new instance of set corresponding to the supplied string
Note
Only works for strings containing only alphabetic characters. like EUR, GBP etc.
Set.union ( var  set1,
var  set2 
)

Creates a union of two existing sets.

Parameters
set1the first set
set2the second set
Returns
a new set containing all elements from set1 and set2
Set toString ( )

Converts a set to a string representation.

Returns
a comma-separated list of the elements in the set

Generated on Wed Jul 31 2024 18:00:22 for Transformer Pipeline Module API Reference