OpenTestSystem.Otx.Core.Terms.GetBit Class Reference

Gets bit from a byte field More...

Inheritance diagram for OpenTestSystem.Otx.Core.Terms.GetBit:

Public Attributes
ByteFieldTerm	byteField
	The ByteField in which the bit shall be looked up. More...
NumericTerm	index
	The zero based byte index of the byte in which the bit of interest resides. The bytes in a ByteField of byte size n are ordered from left to right, where the leftmost byte have a byte index of 0 and the rightmost byte have a byte index of n-1. More...
NumericTerm	position
	The zero based bit position of the bit within the identified byte. The bits in each byte of the ByteField are ordered from the least significant bit (LSB) to the most significant bit (MSB). More...
Public Attributes inherited from OpenTestSystem.Otx.Core.Terms.Term
MetaData	metaData
	Store additional More...

Detailed Description

Gets bit from a byte field

GetBit is a term which on the basis of ByteIndex and BitPosition returns a bit from a ByteField.

Exceptions

Exceptions.OutOfBoundsException

It is thrown if the index is not within the range [0,n-1], where n is the size of the ByteField.

Syntax

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

Examples

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

Member Data Documentation

byteField

ByteFieldTerm OpenTestSystem.Otx.Core.Terms.GetBit.byteField

The ByteField in which the bit shall be looked up.

index

NumericTerm OpenTestSystem.Otx.Core.Terms.GetBit.index

The zero based byte index of the byte in which the bit of interest resides. The bytes in a ByteField of byte size n are ordered from left to right, where the leftmost byte have a byte index of 0 and the rightmost byte have a byte index of n-1.

position

NumericTerm OpenTestSystem.Otx.Core.Terms.GetBit.position

The zero based bit position of the bit within the identified byte. The bits in each byte of the ByteField are ordered from the least significant bit (LSB) to the most significant bit (MSB).