Class BDPolledSingletProperty<Tag, Type>

Type Parameters

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

Hierarchy

BDAbstractSingletProperty<Tag, Type>
- BDPolledSingletProperty

Index

Constructors

Properties

identifier type

Methods

addListener getData getValue on setData setValue

Constructors

constructor

new BDPolledSingletProperty<
    Tag extends ApplicationTag,
    Type extends any = ApplicationTagValueTypeMap[Tag],
>(
    identifier: PropertyIdentifier,
    type: Tag,
    poll: (ctx: BDPropertyAccessContext) => Type,
    encoding?: CharacterStringEncoding,
): BDPolledSingletProperty<Tag, Type>
Type Parameters
- Tag extends ApplicationTag
- Type extends any = ApplicationTagValueTypeMap[Tag]
Parameters
- identifier: PropertyIdentifier
- type: Tag
- poll: (ctx: BDPropertyAccessContext) => Type
- Optionalencoding: CharacterStringEncoding
Returns BDPolledSingletProperty<Tag, Type>
Overrides BDAbstractSingletProperty<Tag, Type>.constructor
- Defined in src/properties/singlet/polled.ts:28

Properties

`Readonly`identifier

identifier: PropertyIdentifier

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

`Readonly`type

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

See

Methods

addListener

addListener<
    K extends keyof BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>,
>(
    event: K,
    cb: EventListener<BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>, K>,
): void
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 void
Inherited from BDAbstractSingletProperty.addListener
- Defined in src/events.ts:60

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/polled.ts:34

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/polled.ts:39

on

on<K extends keyof BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>>(
event: K,
cb: EventListener<BDPropertyEvents<Tag, Type, BACNetAppData<Tag, Type>>, K>,
): BDPolledSingletProperty<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 BDPolledSingletProperty<Tag, Type>
The callback function for chaining
Inherited from BDAbstractSingletProperty.on
- Defined in src/events.ts:48

setData

setData(): 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.

Returns Promise<void>
Overrides BDAbstractSingletProperty.setData
- Defined in src/properties/singlet/polled.ts:50

setValue

setValue(): Promise<void>
Commodity method to set the value of the property rather than the entire data element.

Returns Promise<void>
Overrides BDAbstractSingletProperty.setValue
- Defined in src/properties/singlet/polled.ts:54