Olympe SDK

Class: BitMask

olympe.dc.predicates. BitMask

Predicate that tests whether a value matches a given bit mask.

new BitMask(mask, value)

Creates a BitMask predicate.

Parameters:
Name Type Description
mask olympe.df.ONumber | number | olympe.df.Node | olympe.df.Proxy

The bit mask.
value olympe.dc.ValueDef

The value to test.
Implements:

Methods

getInternalPaths()

Returns the path in the graph followed by this predicate to be evaluated.

Implements:
Returns:
Type
Array.<!Array.<!olympe.dc.query.Relation>>

getName()

Gets the name of this Predicate.

Implements:
Returns:

The name.

Type
string

serialize(parameters)

Serializes the predicate.

Parameters:
Name Type Description
parameters olympe.dc.query.Parameters

Serialization parameters.
Implements:
Throws:

If the predicate is not serializable.

Type
Error
Returns:

A string containing the serialized form.

Type
string

test(dcManager, tag)

Checks whether an instance matches this predicate.

Parameters:
Name Type Description
dcManager olympe.dc.Manager

The DC manager.
tag string

The tag of the instance to test.
Implements:
Returns:

The result of the test as a boolean (or OBoolean) or a node (or proxy) of those types

Type
boolean | olympe.df.Node | olympe.df.OBoolean | olympe.df.Proxy

toString()

Gets a string representation of this Predicate.

Implements:
Returns:

The string representation.

Type
string