I_Set (Interface)

Interface for a set collection.

Extends: I_Collection

Methods

Clear

Returns: I_Set

Empties/Clears/Deletes every item in the set.

Contains

Returns: BOOL

Checks if item is contained in set.

Inputs

Name

Type

Description

Item

ANY

Item to find.

Get_Values

Returns: I_Immutable_List

Gets an immutable list of the values in the set.

Insert

Returns: I_Set

Insert item into set.

Inputs

Name

Type

Description

Item

ANY

Data to insert

Outputs

Name

Type

Description

bSuccess

BOOL

Indicates whether operation was successful. Success = TRUE, Failure = FALSE

Insert_Generic

Returns: I_Set

Adds new generic item at into set. The set will store a copy of the generic item so as to not modify the original value outside it’s scope.

Inputs

Name

Type

Description

Item

T_Generic

Item to store

Outputs

Name

Type

Description

bSuccess

BOOL

Indicates whether operation was successful. Success = TRUE, Failure = FALSE

Remove

Returns: I_Set

Removes item from the set.

Inputs

Name

Type

Description

Item

ANY

Data to remove

Outputs

Name

Type

Description

bSuccess

BOOL

Indicates whether operation was successful. Success = TRUE, Failure = FALSE

Remove_Generic

Returns: I_Set

Removes generic item from the set.

Inputs

Name

Type

Description

Item

T_Generic

Data to remove

Outputs

Name

Type

Description

bSuccess

BOOL

Indicates whether operation was successful. Success = TRUE, Failure = FALSE