FB_Immutable_Map (Function Block)

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

Implements: I_Immutable_Map

Inputs

Name	Type	Description
ipMap	I_Map

Properties

_Count

Type: T_Capacity

Number of items in the collection.

_Empty

Type: BOOL

Checks if collection is empty.

_Error_Status

Type: T_Error

Error status of the collection.

Methods

Contains

Checks if key is contained in the map.

Inputs

Name	Type	Description
Key	ANY	Key to find.

Get

Gets the value associated with the specified key without removing it from the map.

Inputs

Name	Type	Description
Key	ANY	Key used to identify stored value
Value	ANY	Variable to store requested data

Outputs

Name	Type	Description
bSuccess	BOOL

Get_As_String

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

Inputs

Name	Type	Description
Key	ANY	Key used to identify stored value
sValue	REFERENCE TO STRING	Variable to store returned item.

Outputs

Name	Type	Description
bSuccess	BOOL

Get_Keys

Gets an immutable list of the keys.

Get_Values

Gets an immutable list of the values in the map.