FB_Immutable_List (Function Block)

Collection that exposes only immutable methods and properties of a collection that implements I_List.

Implements: I_Immutable_List, I_Iterable

Inputs

Name	Type	Description
`ipList`	I_List

Properties

_Begin

Type: T_Position

Index of the first element.

_Count

Type: T_Capacity

Number of items in the collection.

_Empty

Type: BOOL

Checks if collection is empty.

_End

Type: T_Position

Index of the last element.

_Error_Status

Type: T_Error

Error status of the collection.

Methods

Contains

Checks if item is contained in list.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to find in list

Get

Gets item from list at specified location without removing it.

Inputs

Name	Type	Description
`Index`	T_Position	Location of item
`Item`	`ANY`	Variable to store returned item

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Get_As_String

Returns item as a string, if type to string conversion is supported.

Inputs

Name	Type	Description
`Index`	T_Position	Location of item
`sItem`	`REFERENCE TO` `STRING`	Variable to store returned item.

Outputs

Name	Type	Description
`bSuccess`	`BOOL`

Get_Type_At

Gets the type of the item at specified location.

Inputs

Name	Type	Description
`Index`	T_Position

Outputs

Name	Type	Description
`Item_Type`	T_Type
`bSuccess`	`BOOL`

Search

Find the location of an item in list.

Inputs

Name	Type	Description
`Item`	`ANY`	Item to find in list

Outputs

Name	Type	Description
`Index`	T_Position	Location of item in list
`bSuccess`	`BOOL`