Difference between revisions of "Core.Actions.MapRemoveItems"

From emotive
Jump to navigation Jump to search
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Core]]
+
{{DISPLAYTITLE:OTX '''MapRemoveItems'''}}[[Category:Core]]
 
== Classification ==
 
== Classification ==
{{ClassificationActivity |MapRemoveItems | Deletes one or more elements from a map | [[Action]] | [[Core|OTX Core library]] | [[MapModifiers related actions]] | [[OutOfBoundsException]] | [[CoreChk039|Core_Chk039]]}}
+
{{ClassificationActivity |MapRemoveItems | Deletes one or more elements from a map | [[Action]] | [[Core|OTX Core library]] | [[MapModifiers related actions]] | [[Core.Actions.Throw.Exception.OutOfBoundsException|OutOfBoundsException]] | [[Core.Validation.CoreChk039|Core_Chk039]]}}
  
 
== OTL Syntax ==
 
== OTL Syntax ==
Line 14: Line 14:
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| Map | [[Map]] | [[Variable]] | - | [1] | Map of key/values pairs, from which the items are deleted}}
+
{{TableRowPropertie1| Map | [[Core.DataTypes.ComplexDataType.ContainerDataType.Map|Map]] | [[Variable]] | - | [1] | Map of key/values pairs, from which the items are deleted}}
 
{{TableRowPropertie2| Key | - | [[Term]] | - | [1] | List of one or more keys of type of the map to be deleted from the map}}
 
{{TableRowPropertie2| Key | - | [[Term]] | - | [1] | List of one or more keys of type of the map to be deleted from the map}}
 
|}
 
|}
Line 20: Line 20:
 
== OTL Examples ==
 
== OTL Examples ==
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
 
<syntaxhighlight lang="java" enclose="div" style="font-size: medium;">
public procedure main()
+
Map<Integer,Integer> Map1 = {1:2, 2:3};
{
 
  Map<Integer,Integer> Map1 = {1:2, 2:3};
 
  
  MapRemoveItems(Map1, {1, 2});
+
MapRemoveItems(Map1, {1, 2});
}
 
 
</syntaxhighlight>
 
</syntaxhighlight>
  
 
== See also ==
 
== See also ==
[[Assignment]] <br/>
+
[[Core.Actions.Assignment|Assignment]] <br/>
[[ProcedureCall]] <br/>
+
[[Core.Actions.ProcedureCall|ProcedureCall]] <br/>
[[ShiftRight]] <br/>
+
[[Core.Actions.ShiftRight|ShiftRight]] <br/>
[[ShiftLeft]] <br/>
+
[[Core.Actions.ShiftLeft|ShiftLeft]] <br/>
[[SetBit]] <br/>
+
[[Core.Actions.SetBit|SetBit]] <br/>
[[ReplaceSubByteField]] <br/>
+
[[Core.Actions.ReplaceSubByteField|ReplaceSubByteField]] <br/>
[[AppendByteField]] <br/>
+
[[Core.Actions.AppendByteField|AppendByteField]] <br/>
[[ListConcatenate]] <br/>
+
[[Core.Actions.ListConcatenate|ListConcatenate]] <br/>
[[ListAppendItems]] <br/>
+
[[Core.Actions.ListAppendItems|ListAppendItems]] <br/>
[[ListInsertItems]] <br/>
+
[[Core.Actions.ListInsertItems|ListInsertItems]] <br/>
[[ListRemoveItems]] <br/>
+
[[Core.Actions.ListRemoveItems|ListRemoveItems]] <br/>
[[ListClear]] <br/>
+
[[Core.Actions.ListClear|ListClear]] <br/>
[[MapUnion]] <br/>
+
[[Core.Actions.MapUnion|MapUnion]] <br/>
[[MapPutItems]] <br/>
+
[[Core.Actions.MapPutItems|MapPutItems]] <br/>
[[MapClear]]
+
[[Core.Actions.MapClear|MapClear]]

Latest revision as of 08:58, 16 February 2016

Classification

Name MapRemoveItems
Short Description Deletes one or more elements from a map
Class Action
Extension OTX Core library
Group MapModifiers related actions
Exceptions OutOfBoundsException
Checker Rules Core_Chk039
Standard Compliant Yes

OTL Syntax

MapRemoveItems(MapVariable, {Key1, Key2, ...});

Description

The OTX MapRemoveItems activity deletes one or more elements from a map.

Properties

Name Data Type Class Default Cardinality Description
Map Map Variable - [1] Map of key/values pairs, from which the items are deleted
Key - Term - [1] List of one or more keys of type of the map to be deleted from the map

OTL Examples

Map<Integer,Integer> Map1 = {1:2, 2:3};

MapRemoveItems(Map1, {1, 2});

See also

Assignment
ProcedureCall
ShiftRight
ShiftLeft
SetBit
ReplaceSubByteField
AppendByteField
ListConcatenate
ListAppendItems
ListInsertItems
ListRemoveItems
ListClear
MapUnion
MapPutItems
MapClear