TcTypeRegistry | tc-context

Class responsible for creating and managing the TwinCAT Type Map, which is fetched from the TwinCAT's ADS layer.

Hierarchy

TcEmitter
- TcTypeRegistry

Index

Constructors

constructor

Events

Constructors

constructor

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

Overrides TcEmitter.constructor
- Defined in src/tc-type-registry.ts:37
Constructor, which uses the TcContext's TcCom Object for ADS Communication

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

Events

on

on(event: "created", listener: (e: TcTypeRegistryCreatedEvent) => void): any
on(event: "destroyed", listener: (e: TcTypeRegistryDestroyedEvent) => void): any

Overrides TcBinding.on
- Defined in src/tc-type-registry.ts:111
Emitted when TcTypeRegistry creates the Type Map

Parameters
- event: "created"
- listener: (e: TcTypeRegistryCreatedEvent) => void
  - - (e: TcTypeRegistryCreatedEvent): void
    - Parameters
      - e: TcTypeRegistryCreatedEvent
      Returns void
Returns any
Overrides TcBinding.on
- Defined in src/tc-type-registry.ts:117
Emitted when TcTypeRegistry destroys the Type Map

Parameters
- event: "destroyed"
- listener: (e: TcTypeRegistryDestroyedEvent) => void
  - - (e: TcTypeRegistryDestroyedEvent): void
    - Parameters
      - e: TcTypeRegistryDestroyedEvent
      Returns void
Returns any

Methods

Private __adsTypeDeleteChild

__adsTypeDeleteChild(index: number, adsTypeData: TcTypeInfo): void

- Defined in src/tc-type-registry.ts:299
Internal function for deleting ADS Child Type Data from ADS Type. Due to the non-linear pattern of registration, this is useful, as a means of preventing redundant looping

Parameters
- index: number
  
  Index of the ADS Child Type to be deleted
- adsTypeData: TcTypeInfo
  
  The ADS Type from which the child is deleted
Returns void

Private __adsTypeDeleteEntry

__adsTypeDeleteEntry(adsTypeData: TcTypeInfo, adsTypeDataMap: TcTypeInfoMap): void

- Defined in src/tc-type-registry.ts:286
Internal function for deleting ADS Type Data entry from the full map of ADS Type Data Due to the non-linear pattern of registration, this is useful, as a means of preventing redundant looping

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type Data to delete from map
- adsTypeDataMap: TcTypeInfoMap
  
  The ADS Type Map from which the entry is deleted
Returns void

Private __adsTypeHasParent

__adsTypeHasParent(adsTypeData: TcTypeInfo, adsTypeDataMap: TcTypeInfoMap): TcTypeInfo | undefined

- Defined in src/tc-type-registry.ts:354
Internal function, which check if the provided ADS Type Data, has a parent associated with it

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type to check for parent presence
- adsTypeDataMap: TcTypeInfoMap
  
  The full ADS Type Map, where the parent's existence is checked
Returns TcTypeInfo | undefined
- The parents ADS Type Data if it exists, else undefined

Private __adsTypeIsBit

__adsTypeIsBit(adsTypeData: TcTypeInfo): boolean

- Defined in src/tc-type-registry.ts:317
Internal function, which checks if the ADS Type Data is of type BOOL

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type Data, which is checked for being of type BOOL
Returns boolean
- Is true if ADS Type Data matched queried type

Private __adsTypeIsNumber

__adsTypeIsNumber(adsTypeData: TcTypeInfo): boolean

- Defined in src/tc-type-registry.ts:333
Internal function, which checks if the ADS Type Data is of type Integer or Floating Point Number

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type Data, which is checked for being of type Integer or Floating Point Number
Returns boolean
- Is true if ADS Type Data matched queried type

Private __adsTypeIsPointerOrReference

__adsTypeIsPointerOrReference(adsTypeData: TcTypeInfo): boolean

- Defined in src/tc-type-registry.ts:372
Internal function, which filters out Pointers and References

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type Data, which is checked for being either a Pointer or a Reference
Returns boolean
- Is true if the passed ADS Type Data is of type Pointer or Reference

Private __adsTypeIsString

__adsTypeIsString(adsTypeData: TcTypeInfo): boolean

- Defined in src/tc-type-registry.ts:325
Internal function, which checks if the ADS Type Data is of type STRING

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type Data, which is checked for being of type STRING
Returns boolean
- Is true if ADS Type Data matched queried type

Private __adsTypeIsStruct

__adsTypeIsStruct(adsTypeData: TcTypeInfo): number | false

- Defined in src/tc-type-registry.ts:309
Internal function, which checks if the ADS Type Data is of type Structure or Function_Block

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type Data, which is checked for being of type Structure or Function_Block
Returns number | false
- Is true if ADS Type Data matched queried type

Private __adsTypeProcess

__adsTypeProcess(adsTypeData: TcTypeInfo, adsTypeDataMap: TcTypeInfoMap): Promise<TcType | undefined>

- Defined in src/tc-type-registry.ts:173
Internal function for processing ADS Type Data, after it was initially filtered.

throws

TcComIsInvalidException - Attempting to use an invalidated TcCom Object

throws

TcComToRawException - Error occurred when transforming value to raw data

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type Data to process
- adsTypeDataMap: TcTypeInfoMap
  
  The full map of ADS Type Data, for parent/child analysis
Returns Promise<TcType | undefined>
- Either the created TcType from the ADS Type Data, or undefined, if the Type is not bindable

Private __adsTypeProcessChildren

__adsTypeProcessChildren(adsTypeData: TcTypeInfo, adsTypeDataMap: TcTypeInfoMap): Promise<{ key: string; type: TcType }[]>

- Defined in src/tc-type-registry.ts:245
Internal function for checking if an ADS Type Data has children, and if so, will attempt to register all the children associated with this ADS Type

throws

TcComIsInvalidException - Attempting to use an invalidated TcCom Object

throws

TcComToRawException - Error occurred when transforming value to raw data

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type, whose children are evaluated
- adsTypeDataMap: TcTypeInfoMap
  
  The full map of ADS Type Data, for parent/child analysis
Returns Promise<{ key: string; type: TcType }[]>
- List of registered TcType Children with their key. If no children were successfully registered - the list is empty

Private __adsTypeProcessParent

__adsTypeProcessParent(adsTypeData: TcTypeInfo, adsTypeDataMap: TcTypeInfoMap): Promise<TcType | undefined>

- Defined in src/tc-type-registry.ts:225
Internal function for checking if an ADS Type Data has a parent, and if so, will attempt to register that parent

throws

TcComIsInvalidException - Attempting to use an invalidated TcCom Object

throws

TcComToRawException - Error occurred when transforming value to raw data

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type, whose parent is evaluated
- adsTypeDataMap: TcTypeInfoMap
  
  The full map of ADS Type Data, for parent/child analysis
Returns Promise<TcType | undefined>
- Either the processed parent's registered TcType Object, or undefined if that processing has failed

Private __adsTypeRegister

__adsTypeRegister(adsTypeData: TcTypeInfo, adsTypeDataMap: TcTypeInfoMap): Promise<TcType | undefined>

- Defined in src/tc-type-registry.ts:136
Internal function for processing and registering a TcType based on the ADS Type Data collected previously. If Type is not bindable, it is ignored and not registered.

throws

TcComIsInvalidException - Attempting to use an invalidated TcCom Object

throws

TcComToRawException - Error occurred when transforming value to raw data

Parameters
- adsTypeData: TcTypeInfo
  
  The ADS Type Data to process and potentially register
- adsTypeDataMap: TcTypeInfoMap
  
  The full map of ADS Type Data, for parent/child analysis
Returns Promise<TcType | undefined>
- Either the newly registered TcType, or undefined, if registration failed

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-type-registry.ts:61
Creates the Type Map, by querying data through TcContext's TcCom Object and processing it. TcCom must be in a valid state before the Type Map creation can be made.

throws

TcComIsInvalidException - TcCom has not been initialized before creating Type Map

throws

TcComTypeQueryException - Failed to query Type Data

throws

TcComToRawException - Error occurred when transforming value to raw data

Returns Promise<void>

destroy

destroy(): void

- Defined in src/tc-type-registry.ts:77
Destroys the previously created Type 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

has

has(name: string): TcType | undefined

- Defined in src/tc-type-registry.ts:103
Returns a TcType of the provided name from the Type Map. If Type does not exist in the Type Map, returns undefined

Parameters
- name: string
  
  The name of the TcType to get
Returns TcType | undefined
- Either that Type Data under the provided name, or undefined if Type does not exist

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[]

register

- Defined in src/tc-type-registry.ts:90
Registers a TcType created Object as part of the Type Map, under the provided name

Parameters
- name: string
  
  The Type Name of the created TcType Object
- type: TcType
  
  The created TcType Object to register with the Type Map
Returns void

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

Methods

Constructors

constructor

Parameters

context: TcContext

Default value debug: boolean = false

Returns TcTypeRegistry

Events

on

Parameters

event: "created"

listener: (e: TcTypeRegistryCreatedEvent) => void

Parameters

e: TcTypeRegistryCreatedEvent

Returns void

Returns any

Parameters

event: "destroyed"

listener: (e: TcTypeRegistryDestroyedEvent) => void

Parameters

e: TcTypeRegistryDestroyedEvent

Returns void

Returns any

Methods

Private __adsTypeDeleteChild

Parameters

index: number

adsTypeData: TcTypeInfo

Returns void

Private __adsTypeDeleteEntry

Parameters

adsTypeData: TcTypeInfo

adsTypeDataMap: TcTypeInfoMap

Returns void

Private __adsTypeHasParent

Parameters

adsTypeData: TcTypeInfo

adsTypeDataMap: TcTypeInfoMap

Returns TcTypeInfo | undefined

Private __adsTypeIsBit

Parameters

adsTypeData: TcTypeInfo

Returns boolean

Private __adsTypeIsNumber

Parameters

adsTypeData: TcTypeInfo

Returns boolean

Private __adsTypeIsPointerOrReference

Parameters

adsTypeData: TcTypeInfo

Returns boolean

Private __adsTypeIsString

Parameters

adsTypeData: TcTypeInfo

Returns boolean

Private __adsTypeIsStruct

Parameters

adsTypeData: TcTypeInfo

Returns number | false

Private __adsTypeProcess

Parameters

adsTypeData: TcTypeInfo

adsTypeDataMap: TcTypeInfoMap

Returns Promise<TcType | undefined>

Private __adsTypeProcessChildren

Parameters

adsTypeData: TcTypeInfo

adsTypeDataMap: TcTypeInfoMap

Returns Promise<{ key: string; type: TcType }[]>

Private __adsTypeProcessParent

Parameters

adsTypeData: TcTypeInfo

adsTypeDataMap: TcTypeInfoMap

Returns Promise<TcType | undefined>

Private __adsTypeRegister

Parameters