Core.Terms.GetBit

From emotive
Revision as of 10:50, 16 February 2016 by Hb (talk | contribs) (→‎Classification)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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 Integer Term - [1] Zero based index of the byte in the ByteField
Position 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