Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Function_BAND

Function BAND

Returns the binary AND of two numbers. Executes an AND-Operation (&&) on each bit-pair. A bit is true, if the bits at both numbers at the same index are true. Requires two arguments from type boolean or number.

  • Name: BAND

Signature:

(number | boolean) & (number|boolean) => number
BAND(number|boolean, number|boolean) => number
BAND( (number|boolean)[2] ) => number

Hierarchy

Implements

Index

Constructors

Methods

Constructors

Private constructor

Methods

clone

execute

executeAsync

  • executeAsync(preexecutedArguments: any[], environment: ScriptEnvironment, node: Node, execPath?: undefined | string): Promise<any>

  • Parameters

    • preexecutedArguments: any[]
    • environment: ScriptEnvironment
    • node: Node
    • Optional execPath: undefined | string

    Returns Promise<any>

Protected executeBinaryOperation

  • executeBinaryOperation(argumentLeft: number, argumentRight: number): number

  • Parameters

    • argumentLeft: number
    • argumentRight: number

    Returns number

Protected getArgumentError

  • Returns the first argument with error inside args, if args is an array. Or args itself, if args is an object of ExpressionError (or derived).

    Parameters

    • args: any | any[]

    Returns ExpressionError | undefined

Protected getArgumentValue

  • getArgumentValue(argument: any, index: number, node: Node): number

  • Returns the provided argument as integer-number. Throws an error if conversion failed!

    Parameters

    • argument: any
    • index: number
    • node: Node

    Returns number

getDescription

  • getDescription(): string

  • Returns the description of this function. An empty string if a description is not available.

    Returns string

getName

  • getName(): string

  • Returns the name of the function

    Returns string

getOperator

  • getOperator(): string

  • Returns the operator-character of this function. Throws an error if this function is not useable as operation.

    Returns string

getPriority

  • getPriority(): number

  • Returns the priority of this function. Only needed for operators.

    Returns number

Protected hasArgumentError

  • hasArgumentError(args: any | any[]): boolean

  • Returns true if args is an ExpressionError-object or an array which contains an ExpressionError-object.

    Parameters

    • args: any | any[]

    Returns boolean

hasHigherPriorityThan

  • hasHigherPriorityThan(priority: number): boolean

isAsyncron

  • isAsyncron(): boolean

  • Returns true if this function must be called asyncron and returns the value not immediately.

    Returns boolean

isOperator

  • isOperator(): boolean

  • Returns true if this function is also available as operation (using operator)

    Returns boolean

isPreexecutedArgument

  • isPreexecutedArgument(index: number, node: Node): boolean

  • Returns true, if the argument (node-children) should be executed before execute of this function is called. By default, returns true for all arguments. Override in function if certain arguments are executed for getting ther value inside the execute-method.

    Parameters

    • index: number

      Zero-based index of the argument

    • node: Node

      The node, none executed (result is not availabe at that time)

    Returns boolean

isStoring

  • isStoring(): boolean

  • Returns true if this function is storing values between the calls. So, an instance needs to be created for each occurrence.

    Returns boolean

toString

  • toString(): string

Static META

  • Returns Function_BAND

Generated using TypeDoc