Class BDSingletProperty<Tag, Type>

Type Parameters

Tag extends ApplicationTag
Type extends ApplicationTagValueTypeMap[Tag] = ApplicationTagValueTypeMap[Tag]

Hierarchy

BDAbstractSingletProperty<Tag, Type>
- BDSingletProperty

Index

Constructors

constructor

new BDSingletProperty<
    Tag extends ApplicationTag,
    Type extends any = ApplicationTagValueTypeMap[Tag],
>(
    identifier: PropertyIdentifier,
    type: Tag,
    writable: boolean,
    value: Type,
    encoding?: CharacterStringEncoding,
): BDSingletProperty<Tag, Type>
Type Parameters
- Tag extends ApplicationTag
- Type extends any = ApplicationTagValueTypeMap[Tag]
Parameters
- identifier: PropertyIdentifier
- type: Tag
- writable: boolean
- value: Type
- Optionalencoding: CharacterStringEncoding
Returns BDSingletProperty<Tag, Type>
Overrides BDAbstractSingletProperty<Tag, Type>.constructor
- Defined in src/properties/singlet/singlet.ts:24

Properties

`Readonly`identifier

identifier: PropertyIdentifier

The BACnet identifier for this property. Must be unique within the properties added to the same object.

`Readonly`type

type: SINGLET

Whether the property representes a single value or an array (or list) of values.

See

BDPropertyType

Methods

addListener

addListener<
    K extends keyof BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>,
>(
    event: K,
    cb: EventListener<BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>, K>,
): BDSingletProperty<Tag, Type>
Alias for on
Type Parameters
- K extends keyof BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>
Parameters
- event: K
- cb: EventListener<BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>, K>
Returns BDSingletProperty<Tag, Type>
Inherited from BDAbstractSingletProperty.addListener
- Defined in src/events.ts:76

getData

getData(ctx?: BDPropertyAccessContext): BACNetAppData<Tag, Type>
Consumer-facing method to retrieve property data. Implementations of this method should encapsulate retrieval logic as a task that is executed via this property's task queue.
Parameters
- Optionalctx: BDPropertyAccessContext
Returns BACNetAppData<Tag, Type>
Overrides BDAbstractSingletProperty.getData
- Defined in src/properties/singlet/singlet.ts:30

getValue

getValue(ctx?: BDPropertyAccessContext): Type
Commodity method to get the value of the property rather than the entire data element.
Parameters
- Optionalctx: BDPropertyAccessContext
Returns Type
Overrides BDAbstractSingletProperty.getValue
- Defined in src/properties/singlet/singlet.ts:34

off

off<K extends keyof BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>>(
event: K,
cb: EventListener<BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>, K>,
): BDSingletProperty<Tag, Type>
Removes a listener from the set of listeners for the specified event.
Type Parameters
- K extends keyof BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>
Parameters
- event: K
  The event name to subscribe to
- cb: EventListener<BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>, K>
  The callback function to execute when the event is triggered
Returns BDSingletProperty<Tag, Type>
The event emitter's instance for chaining
Inherited from BDAbstractSingletProperty.off
- Defined in src/events.ts:64

on

on<K extends keyof BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>>(
event: K,
cb: EventListener<BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>, K>,
): BDSingletProperty<Tag, Type>
Adds a new listener for the specified event.
Type Parameters
- K extends keyof BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>
Parameters
- event: K
  The event name to subscribe to
- cb: EventListener<BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>, K>
  The callback function to execute when the event is triggered
Returns BDSingletProperty<Tag, Type>
The callback function for chaining
Inherited from BDAbstractSingletProperty.on
- Defined in src/events.ts:48

removeListener

removeListener<
    K extends keyof BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>,
>(
    event: K,
    cb: EventListener<BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>, K>,
): BDSingletProperty<Tag, Type>
Alias for off
Type Parameters
- K extends keyof BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>
Parameters
- event: K
- cb: EventListener<BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>, K>
Returns BDSingletProperty<Tag, Type>
Inherited from BDAbstractSingletProperty.removeListener
- Defined in src/events.ts:83

setData

setData(data: BACNetAppData<Tag, Type>): Promise<void>
Consumer-facing method to set property data. Implementations of this method should encapsulate retrieval logic as a task that is executed via this property's task queue.
Parameters
- data: BACNetAppData<Tag, Type>
Returns Promise<void>
Overrides BDAbstractSingletProperty.setData
- Defined in src/properties/singlet/singlet.ts:38

setValue

setValue(value: Type): Promise<void>
Commodity method to set the value of the property rather than the entire data element.
Parameters
- value: Type
Returns Promise<void>
Overrides BDAbstractSingletProperty.setValue
- Defined in src/properties/singlet/singlet.ts:44

Class BDSingletProperty<Tag, Type>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BDSingletProperty<Tag, Type>

Properties

Readonlyidentifier

Readonlytype

See

Methods

addListener

Type Parameters

Parameters

Returns BDSingletProperty<Tag, Type>

getData

Parameters

Returns BACNetAppData<Tag, Type>

getValue

Parameters

Returns Type

off

Type Parameters

Parameters

Returns BDSingletProperty<Tag, Type>

on

Type Parameters

Parameters

Returns BDSingletProperty<Tag, Type>

removeListener

Type Parameters

Parameters

Returns BDSingletProperty<Tag, Type>

setData

Parameters

Returns Promise<void>

setValue

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`identifier

`Readonly`type