Difference between revisions of "Core.Actions.SetBit"

From emotive
Jump to navigation Jump to search
m (Hb moved page Core.OtxActions.SetBit to Core.Actions.SetBit: #3153)
Line 1: Line 1:
[[Category:Core]]
+
{{DISPLAYTITLE:OTX '''SetBit'''}}[[Category:Core]]
 
== Classification ==
 
== Classification ==
 
{{ClassificationActivity | SetBit | Sets a bit in a ByteField | [[Action]] | [[Core|OTX Core library]] | [[ByteFieldModifiers related actions]] | [[OutOfBoundsException]] | - }}
 
{{ClassificationActivity | SetBit | Sets a bit in a ByteField | [[Action]] | [[Core|OTX Core library]] | [[ByteFieldModifiers related actions]] | [[OutOfBoundsException]] | - }}
Line 9: Line 9:
  
 
== Description ==
 
== Description ==
The OTX '''SetBit''' activity sets a bit in a [[ByteField]].
+
The OTX '''SetBit''' activity sets a bit in a [[Core.DataTypes.ComplexDataType.ByteField|ByteField]].
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ByteField | [[ByteField]] | [[Variable]] | - | [1] | Variable of type ByteField in which the bit should be set}}
+
{{TableRowPropertie1| ByteField | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Variable]] | - | [1] | Variable of type ByteField in which the bit should be set}}
{{TableRowPropertie2| Index | [[Integer]] | [[Term]] | - | [1] | The byte in the ByteField in which the bit will be used to determine}}
+
{{TableRowPropertie2| Index | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | The byte in the ByteField in which the bit will be used to determine}}
{{TableRowPropertie1| Position | [[Integer]] | [[Term]] | - | [1] | Bit position in the byte where bit should be set}}
+
{{TableRowPropertie1| Position | [[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | Bit position in the byte where bit should be set}}
{{TableRowPropertie2| Value | [[Boolean]] | [[Term]] | - | [1] | True or false value to which the bit is set}}
+
{{TableRowPropertie2| Value | [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | [[Term]] | - | [1] | True or false value to which the bit is set}}
 
|}
 
|}
  

Revision as of 09:53, 4 February 2016

Classification

Name SetBit
Short Description Sets a bit in a ByteField
Class Action
Extension OTX Core library
Group ByteFieldModifiers related actions
Exceptions OutOfBoundsException
Checker Rules -
Standard Compliant Yes

OTL Syntax

ByteField.SetBit(ByteFieldVariable, IntegerTerm, IntegerTerm, BooleanTerm);

Description

The OTX SetBit activity sets a bit in a ByteField.

Properties

Name Data Type Class Default Cardinality Description
ByteField ByteField Variable - [1] Variable of type ByteField in which the bit should be set
Index Integer Term - [1] The byte in the ByteField in which the bit will be used to determine
Position Integer Term - [1] Bit position in the byte where bit should be set
Value Boolean Term - [1] True or false value to which the bit is set

OTL Examples

Integer Positions1 = 1;
ByteField ByteField1 = &00FF;
Integer Index1;

ByteField.SetBit(ByteField1, Index1, Positions1, false);

See also

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