Difference between revisions of "Core.Terms.GetBit"

From emotive
Jump to navigation Jump to search
m (Hb moved page GetBit to Core.Terms.GetBit: #3153)
Line 1: Line 1:
[[Category:Core]]
+
{{DISPLAYTITLE:OTX '''GetBit'''}}[[Category:Core]]
 
== Classification ==
 
== Classification ==
 
{{ClassificationActivity | GetBit | Value a bit at a specified position in the ByteField | [[Term]] | [[Core|OTX Core library]] | [[ByteField operations]] | - | - }}
 
{{ClassificationActivity | GetBit | Value a bit at a specified position in the ByteField | [[Term]] | [[Core|OTX Core library]] | [[ByteField operations]] | - | - }}
Line 13: Line 13:
 
{{Important|Please keep in mind that this [[TermActivity]] in the form of an activity exists and no text can be entered. According to the respective [[ActionNode]] can further properties are added.}}
 
{{Important|Please keep in mind that this [[TermActivity]] in the form of an activity exists and no text can be entered. According to the respective [[ActionNode]] can further properties are added.}}
  
{{TermReturnValue| [[Boolean]] | Return of the value of the bits in the operands}}
+
{{TermReturnValue| [[Core.DataTypes.SimpleDataType.Boolean|Boolean]] | Return of the value of the bits in the operands}}
  
 
== Properties ==
 
== Properties ==
 
{| {{TableHeader}}
 
{| {{TableHeader}}
 
{{TableRowPropertiesHeader}}
 
{{TableRowPropertiesHeader}}
{{TableRowPropertie1| ByteFieldTerm | [[ByteField]] | [[Term]] | - | [1] | Source ByteField}}
+
{{TableRowPropertie1| ByteFieldTerm | [[Core.DataTypes.ComplexDataType.ByteField|ByteField]] | [[Term]] | - | [1] | Source ByteField}}
{{TableRowPropertie2| Index | [[Integer]] | [[Term]] | - | [1] | Zero based index of the byte in the ByteField}}
+
{{TableRowPropertie2| Index | [[[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | Zero based index of the byte in the ByteField}}
{{TableRowPropertie1| Position | [[Integer]] | [[Term]] | - | [1] | Zero based index of the bits in the corresponding byte}}
+
{{TableRowPropertie1| Position | [[[Core.DataTypes.SimpleDataType.Integer|Integer]] | [[Term]] | - | [1] | Zero based index of the bits in the corresponding byte}}
 
|}
 
|}
  
Line 31: Line 31:
  
 
== See also ==
 
== See also ==
[[BitwiseAnd]] <br/>
+
[[Core.Terms.BitwiseAnd|BitwiseAnd]] <br/>
[[BitwiseOr]] <br/>
+
[[Core.Terms.BitwiseOr|BitwiseOr]] <br/>
[[BitwiseXor]] <br/>
+
[[Core.Terms.BitwiseXor|BitwiseXor]] <br/>
[[BitwiseNot]] <br/>
+
[[Core.Terms.BitwiseNot|BitwiseNot]] <br/>
[[ByteFieldGetSize]] <br/>
+
[[Core.Terms.ByteFieldGetSize|ByteFieldGetSize]] <br/>
[[SubByteField]]
+
[[Core.Terms.SubByteField|SubByteField]]

Revision as of 04:02, 5 February 2016

Classification

Name GetBit
Short Description Value a bit at a specified position in the ByteField
Class Term
Extension OTX Core library
Group ByteField operations
Exceptions -
Checker Rules -
Standard Compliant Yes

OTL Syntax

Value = ByteField.GetBit(ByteFieldTerm, IntegerTerm, IntegerTerm);

Description

GetBit is a term, which returns true as a result, if the bit at the corresponding position in the ByteField has the value 1, otherwise false .

Exclamation.png Important: Please keep in mind that this TermActivity in the form of an activity exists and no text can be entered. According to the respective ActionNode can further properties are added.

Return Value

The Term returns the value, see table below.

Icons Note.png In OTX, Terms are categorized according to its return data type!
Data Type Description
Boolean Return of the value of the bits in the operands

Properties

Name Data Type Class Default Cardinality Description
ByteFieldTerm ByteField Term - [1] Source ByteField
Index [[[Core.DataTypes.SimpleDataType.Integer|Integer]] Term - [1] Zero based index of the byte in the ByteField
Position [[[Core.DataTypes.SimpleDataType.Integer|Integer]] Term - [1] Zero based index of the bits in the corresponding byte

Examples

Boolean result;
result = ByteField.GetBit(&1234, 1, 1);
//Returns result = false

See also

BitwiseAnd
BitwiseOr
BitwiseXor
BitwiseNot
ByteFieldGetSize
SubByteField