oBit Object

Description
Operation
Properties
Methods

Examples
Related
Version History & Bug list

The oBit Object manages a 1-Bit variable that can be used in a virtual circuit. As well as the value of the variable, status properties are also provided that can be used in a virtual circuit.

There are three main differences between this object and a standard Bit variable.

This Object's Value property is an instance of the oValue Object which can be pointed to by a Virtual Circuit.
This Object maintains status bits which can be pointed to by Virtual Circuits.
This Object is 7-bits larger in order to store the status information.

The following table lists the size and availability of the oBit Object.

	Object	Size	Description	A1	A2	B1	B2	C1
	oBit	1 Byte	Manages a value with a range of 1 to 0.	x	x	x	x	x

Operation:

An oBit Object variable stores a 1 bit value in its Value property and maintains other values that represent the status of that 1 bit.

Since the Value property of the oBit Object is an oValue property, Virtual Circuits that have an oValue pointer can point to it. In addition, to keep backwards compatibility, the compiler will treat the Value property as on oLogic object as well. Therefore, A Virtual Circuit connection may be made to the Value property by either an oValue pointer or an oLogic pointer.

Properties:

The following table lists the properties of the oBit Object:

Property
Description

Value

The value of the 1-bit variable.

Object Class: oValue Value Range: 0 - 1

Data Type: Numeric Default Value: 0

IsSet

A value that indicates if the value is 1.

Object Class: oProperty Value Range: 0 - 1

Data Type: Numeric (Read-Only) Default Value: 0

IsClear

A value that indicates if the value is 0.

Object Class: oProperty Value Range: 0 - 1

Data Type: Numeric (Read-Only) Default Value: 0

Data

The data for the Value property.

Object Class: oVar1 Value Range: 0 to 1

Data Type: Numeric Default Value: 0

Address

Returns a pointer to the address of the oCounter Object instance.

Object Class: oAddress Value Range: 0 - 127

Data Type: Pointer (Read Only) Default Value: Address of Object

Methods:

The following table lists the Methods of the oBit Object:

Methods Description

Clear
Clears the Value property to 0.

Invert
Toggles the bit in the Value property

Set
Sets the Value property to 1.

Init
Initializes the value when the object is created.

Example:

The following examples use the oBit Object.

Visual Basic Syntax

C and Java Syntax

Dim A As New oBit
Dim B As New oNibble
Dim C As New oByte
Dim D As New oWord

Sub Main()  
  A = 1
  B = 2  
  C = 3
  D = 4
End Sub

oBit A = New oBit;
oNibble B = New oNibble;
oByte C = New oByte;
oWord D = New oWord;

Void Main(Void){
  A = 1;
  B = 2;
  C = 3;
  D = 4;
}

Basic Syntax

A As oBit
B As oNibble
C As oByte
D As oWord

A = 1
B = 2  
C = 3
D = 4

Related Items:

The following table lists objects that use the oBit Object.

Object	Description	A1	A2	B1	B2	C1
oDIO1	Provides a 1 line digital I/O.	x	x	x	x	x
oStepper	Controls a stepper motor.			x	x	x
oStepperSP	Controls a stepper motors speed				x	x

The following table lists objects with related functions

Object	Description	A1	A2	B1	B2	C1
oNib	Manages a 4-bit value with a range of 0 to 15.	x	x	x	x	x
oNibX	Manages a 4-bit signed value with a range of -8 to +7.					x
oByte	Manages a 8-bit value with a range of 0 to 255.	x	x	x	x	x
oChar	Manages a 8-bit signed value with a range of -128 to -127.			x	x	x
oWord	Manages a 16-bit value with a range of 0 to 65,535.	x	x	x	x	x
oInt	Manages a 16-bit signed value with a range of -32,768 to +32,767.			x	x	x
oBuffer(1-32)	32 Objects that Manage various sized data-buffer/string variable.	x	x	x	x	x

Version History and Bug List:

Firmware Ver A1: Introduced.

Bugs: No known bugs.