InvalidBitNumber class: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "<!-- InvalidBitNumber class --> __NOTOC__ The <var>InvalidBitNumber</var> exception class indicates that a bit number request by a bit manipulation function was incorrect, eit...")
 
Line 35: Line 35:


<tr><th nowrap="nowrap"><var>[%(InvalidBitNumber):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a <var>InvalidBitNumber</var> <var>Constructor</var>.</td></tr>
<tr><th nowrap="nowrap"><var>[%(InvalidBitNumber):]</var></th><td>The class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors|Constructor]]</var>. See [[#Usage notes|"Usage notes"]], below, for more information about invoking a <var>InvalidBitNumber</var> <var>Constructor</var>.</td></tr>
<tr><th><var class="term">number</var></th><td>The bit number that will be returned by the BitNumber property.</td></tr>
</table>
</table>



Revision as of 23:13, 21 March 2013


The InvalidBitNumber exception class indicates that a bit number request by a bit manipulation function was incorrect, either negative, greater than the number of bits in the string, or non-integral.

To produce a InvalidBitNumber exception for yourself, you typically use a User Language Throw statement with an InvalidBitNumber New constructor. For example, the following statement throws an InvalidBitNumber exception:

throw %(invalidBitNumber):new


The InvalidBitNumber methods

The following are the available InvalidTranslateTable class methods.

MethodDescription
NewCreate a new InvalidTranslateTable object

The methods in the class are described in the subsections that follow. In addition:


New constructor

Create a new InvalidBitNumber object (InvalidBitNumber class)

[Introduced in Model 204 7.5]

This Constructor generates an instance of an InvalidBitNumber exception. The New method format is as follows:

Syntax

%invalidBitNumber = [%(InvalidBitNumber):]New( bitNumber= number)

Syntax terms

%invalidBitNumber A reference to an instance of a InvalidBitNumber object.
[%(InvalidBitNumber):]The class name in parentheses denotes a Constructor. See "Usage notes", below, for more information about invoking a InvalidBitNumber Constructor.
numberThe bit number that will be returned by the BitNumber property.

Usage notes

  • As described in "Using New or other Constructors", New can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is Null:

    %invalidBitNumber = new %invalidBitNumber = %(InvalidBitNumber):new %invalidBitNumber = %invalidBitNumber:new