TcSymbolRegistry | tc-context

Class responsible for creating and managing the TwinCAT Symbol map, which is fetched from the TwinCAT's Target PLC and processed through the previously created TcTypeRegistry of the TcContext

Hierarchy

TcEmitter
- TcSymbolRegistry

Index

Constructors

constructor

Events

Accessors

namespaces

Methods

Constructors

constructor

new TcSymbolRegistry(context: TcContext, debug?: boolean): TcSymbolRegistry

Overrides TcEmitter.constructor
- Defined in src/tc-symbol-registry.ts:38
Constructor, which used the TcContext's TcCom Object for ADS Communication and the TcContext's TcTypeRegistry form Symbol Map generation

Parameters
- context: TcContext
  
  Parent TcContext, of whom TcSymbolRegistry is a part of, and whom to propagate events to
- Default value debug: boolean = false
  
  If enabled, will produce debug information
Returns TcSymbolRegistry

Events

on

on(event: "created", listener: (e: TcSymbolRegistryCreatedEvent) => void): any
on(event: "destroyed", listener: (e: TcSymbolRegistryDestroyedEvent) => void): any
on(event: "set", listener: (e: TcSymbolSetEvent) => void): any
on(event: "get", listener: (e: TcSymbolGetEvent) => void): any
on(event: "cleared", listener: (e: TcSymbolClearedEvent) => void): any
on(event: "changed", listener: (e: TcSymbolChangedEvent) => void): any

Overrides TcBinding.on
- Defined in src/tc-symbol-registry.ts:123
Emitted from TcSymbolRegistry when it creates the Symbol Map

Parameters
- event: "created"
- listener: (e: TcSymbolRegistryCreatedEvent) => void
  - - (e: TcSymbolRegistryCreatedEvent): void
    - Parameters
      - e: TcSymbolRegistryCreatedEvent
      Returns void
Returns any
Overrides TcBinding.on
- Defined in src/tc-symbol-registry.ts:129
Emitted from TcSymbolRegistry when it destroys the Symbol Map

Parameters
- event: "destroyed"
- listener: (e: TcSymbolRegistryDestroyedEvent) => void
  - - (e: TcSymbolRegistryDestroyedEvent): void
    - Parameters
      - e: TcSymbolRegistryDestroyedEvent
      Returns void
Returns any
Overrides TcBinding.on
- Defined in src/tc-symbol-registry.ts:135
Emitted from TcBinding of a TcSymbol when TcSymbol.$set() has completed

Parameters
- event: "set"
- listener: (e: TcSymbolSetEvent) => void
  - - (e: TcSymbolSetEvent): void
    - Parameters
      - e: TcSymbolSetEvent
      Returns void
Returns any
Overrides TcBinding.on
- Defined in src/tc-symbol-registry.ts:141
Emitted from TcBinding of a TcSymbol when TcSymbol.$get has completed

Parameters
- event: "get"
- listener: (e: TcSymbolGetEvent) => void
  - - (e: TcSymbolGetEvent): void
    - Parameters
      - e: TcSymbolGetEvent
      Returns void
Returns any
Overrides TcBinding.on
- Defined in src/tc-symbol-registry.ts:147
Emitted from TcBinding of a TcSymbol when TcSymbol.$clear() has completed

Parameters
- event: "cleared"
- listener: (e: TcSymbolClearedEvent) => void
  - - (e: TcSymbolClearedEvent): void
    - Parameters
      - e: TcSymbolClearedEvent
      Returns void
Returns any
Overrides TcBinding.on
- Defined in src/tc-symbol-registry.ts:153
Emitted from TcBinding of a TcSymbol when TcSymbol detects a change in the PLC Symbol

Parameters
- event: "changed"
- listener: (e: TcSymbolChangedEvent) => void
  - - (e: TcSymbolChangedEvent): void
    - Parameters
      - e: TcSymbolChangedEvent
      Returns void
Returns any

Accessors

namespaces

get namespaces(): {}

- Defined in src/tc-symbol-registry.ts:56
Access the created $TcSymbol Map

Returns {}
- [key: string]: TcNamespaceSymbol

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from TcBinding.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

create

create(): Promise<void>

- Defined in src/tc-symbol-registry.ts:68
Fetches the ADS Symbol Data and creates the Symbol Map based on the Type Information, registered by the TcContext

throws

TcComIsInvalidException - TcCom has not been initialized before creating Symbol Map

throws

TcComSymbolQueryException - Failed to query Symbol Data

throws

TcComToRawException - Error occurred when transforming value to raw data

Returns Promise<void>

destroy

destroy(): void

- Defined in src/tc-symbol-registry.ts:107
Destroys the created Symbol Map, by invalidating all the created TcSymbols and TcNamespaces and cleaning the internal map

Returns void

emit

emit(eventName: string | symbol, e: TcEvent): boolean

Inherited from TcBinding.emit

Overrides EventEmitter.emit
- Defined in src/tc-event.ts:64
Emits an event of eventName with data e and if parent is present will propagated that event to it, unless stopped

Parameters
- eventName: string | symbol
  
  The event name to emit
- e: TcEvent
  
  The Data associated with this event
Returns boolean
- True if the event had listeners, false otherwise.

eventNames

eventNames(): Array<string | symbol>

Inherited from TcBinding.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from TcBinding.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

listenerCount

listenerCount(type: string | symbol): number

Inherited from TcBinding.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from TcBinding.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from TcBinding.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from TcBinding.once
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from TcBinding.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from TcBinding.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from TcBinding.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from TcBinding.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from TcBinding.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from TcBinding.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

Hierarchy

Index

Constructors

Events

Accessors

Methods

Constructors

constructor

Parameters

context: TcContext

Default value debug: boolean = false

Returns TcSymbolRegistry

Events

on

Parameters

event: "created"

listener: (e: TcSymbolRegistryCreatedEvent) => void

Parameters

e: TcSymbolRegistryCreatedEvent

Returns void

Returns any

Parameters

event: "destroyed"

listener: (e: TcSymbolRegistryDestroyedEvent) => void

Parameters

e: TcSymbolRegistryDestroyedEvent

Returns void

Returns any

Parameters

event: "set"

listener: (e: TcSymbolSetEvent) => void

Parameters

e: TcSymbolSetEvent

Returns void

Returns any

Parameters

event: "get"

listener: (e: TcSymbolGetEvent) => void

Parameters

e: TcSymbolGetEvent

Returns void

Returns any

Parameters

event: "cleared"

listener: (e: TcSymbolClearedEvent) => void

Parameters

e: TcSymbolClearedEvent

Returns void

Returns any

Parameters

event: "changed"

listener: (e: TcSymbolChangedEvent) => void

Parameters

e: TcSymbolChangedEvent

Returns void

Returns any

Accessors

namespaces

Returns {}

[key: string]: TcNamespaceSymbol

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns this

create

Returns Promise<void>

destroy

Returns void

emit

Parameters

eventName: string | symbol

e: TcEvent

Returns boolean

eventNames

Returns Array<string | symbol>