CBFS Filter 2020 Node.js Edition

Questions / Feedback?

StrictAltitude Property

How to behave if the specified altitude is already in use.

Syntax

 cbprocess.getStrictAltitude([callback])
 cbprocess.setStrictAltitude( strictAltitude, [callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getStrictAltitude([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setStrictAltitude([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property specifies how the class's system driver should behave if the specified Altitude is already in use when the StartFilter method is called.

If this property is enabled, the filter will fail to attach. If this property is disabled (default), the driver will attempt to use an adjacent altitude value to attach the filter.

Data Type

Boolean

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Node.js Edition - Version 20.0 [Build 8164]