TcEnumSymbol | tc-context

Class representing an instance of a PLC Symbol of Type ENUM.

Hierarchy

TcSymbol
- TcEnumSymbol

Indexable

[key: string]: TcSymbol | TcSymbolMethod

TcSymbols are indexable, in case they are structured types, and can nest children TcSymbols. Alternatively, if a TcSymbol has Rpc Methods enabled, this methods can be also invoked over the index.

Index

Constructors

constructor

Events

Accessors

Methods

Constructors

constructor

new TcEnumSymbol(path: string, parent: TcSymbol, pointer: TcSymbolPointer, params: TcEnumType, debug?: boolean): TcEnumSymbol

Overrides TcSymbol.constructor
- Defined in src/tc-symbol.ts:636
Constructs a TcSymbol, which is designed to interface with a ENUM Symbol on the Target PLC.

Parameters
- path: string
  
  The Path of this Symbol, relative to its origin point
- parent: TcSymbol
  
  Potential parent of this TcSymbol and to whom events will propagate to
- pointer: TcSymbolPointer
  
  The memory location of the Target PLC Symbol
- params: TcEnumType
  
  The Type parameters of this ENUM Symbol
- Default value debug: boolean = false
  
  If enabled, will produce debug information
Returns TcEnumSymbol

Events

$on

$on(event: "set", listener: (e: TcSymbolSetEvent) => void): TcSymbol
$on(event: "get", listener: (e: TcSymbolGetEvent) => void): TcSymbol
$on(event: "cleared", listener: (e: TcSymbolClearedEvent) => void): TcSymbol
$on(event: "changed", listener: (e: TcSymbolChangedEvent) => void): TcSymbol

Inherited from TcSymbol.$on
- Defined in src/tc-symbol.ts:238
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 TcSymbol
Inherited from TcSymbol.$on
- Defined in src/tc-symbol.ts:245
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 TcSymbol
Inherited from TcSymbol.$on
- Defined in src/tc-symbol.ts:252
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 TcSymbol
Inherited from TcSymbol.$on
- Defined in src/tc-symbol.ts:259
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 TcSymbol

Accessors

$binding

get $binding(): TcEnumBinding

Overrides TcSymbol.$binding
- Defined in src/tc-symbol.ts:664
Access the TcBinding of this TcSymbol

Returns TcEnumBinding

$fields

get $fields(): string[]

- Defined in src/tc-symbol.ts:658
Access the fields of this enumerator, which can be written

Returns string[]

$get

get $get(): Promise<string>

Overrides TcSymbol.$get
- Defined in src/tc-symbol.ts:679
Returns the string enum value of this TcSymbol from the Target PLC ENUM Symbol, which the TcSymbol.$binding is linked to.

throws

TcBindingIsInvalidException - Attempting operation on an invalidated TcBinding

throws

TcComIsInvalidException - Attempting operation on an invalidated TcCom Object

throws

TcComDataReadException - An error occurred when fetching the Symbol Data

throws

TcComFromRawException - An error occurred when parsing Data to values

throws

TcBindingOutOfRangeException - Error occurred when parsing returned Data from the Target PLC Symbol

Returns Promise<string>
- The value of the Target PLC Symbol

$parent

get $parent(): TcSymbol | undefined

Inherited from TcSymbol.$parent
- Defined in src/tc-symbol.ts:91
Access the potential parent of this TcSymbol

Returns TcSymbol | undefined

$path

get $path(): string

Inherited from TcSymbol.$path
- Defined in src/tc-symbol.ts:97
Access the path of this TcSymbol from its origin point

Returns string

$readOnly

get $readOnly(): boolean

Inherited from TcSymbol.$readOnly
- Defined in src/tc-symbol.ts:109
Returns true if this TcSymbol is ReadOnly

Returns boolean

Methods

$clear

$clear(): Promise<void>

Inherited from TcSymbol.$clear
- Defined in src/tc-symbol.ts:174
Clears the data of the Target PLC Symbol to their implicit default values, or the explicitly specified ones

throws

TcBindingIsInvalidException - Attempting operation on an invalidated TcBinding

throws

TcComIsInvalidException - Attempting operation on an invalidated TcCom Object

throws

TcComDataWriteException - An error occurred when writing the Symbol Data

throws

TcBindingReadOnlyException - Attempted to clear a ReadOnly Symbol

Returns Promise<void>

$off

$off(eventName: string, listener: (e: any) => void): TcSymbol

Inherited from TcSymbol.$off
- Defined in src/tc-symbol.ts:275
Removes a listener from the specified event

Parameters
- eventName: string
  
  The event name, from which the listener is to be removed
- listener: (e: any) => void
  
  The listener, which is to be removed from the specified event
  - - (e: any): void
    - Parameters
      - e: any
      Returns void
Returns TcSymbol

$onInvalidated

$onInvalidated(callback: (symbol: TcSymbol) => void): void

Inherited from TcSymbol.$onInvalidated
- Defined in src/tc-symbol.ts:227
Attached the provided callback, which will be called when the `TcSymbol becomes invalidated

Parameters
- callback: (symbol: TcSymbol) => void
  
  The function, which is to be called upon invalidation
  - - (symbol: TcSymbol): void
    - Parameters
      - symbol: TcSymbol
      Returns void
Returns void

$once

$once(eventName: string, listener: (e: any) => void): TcSymbol

Inherited from TcSymbol.$once
- Defined in src/tc-symbol.ts:289
Attached a listener to an event, which is only invoked once. For the full list of events, see TcSymbol.$on()

Parameters
- eventName: string
  
  The event name, which the listener will listen for
- listener: (e: any) => void
  
  The listener, which is called when the event is emitted
  - - (e: any): void
    - Parameters
      - e: any
      Returns void
Returns TcSymbol

$set

$set(value: string): Promise<string>

Overrides TcSymbol.$set
- Defined in src/tc-symbol.ts:708
Writes the provided string enum value, which is part of the allowed fields to the Target PLC Symbol, and when completed returns what was written to the Target PLC Symbol

throws

TcBindingIsInvalidException - Attempting operation on an invalidated TcBinding

throws

TcComIsInvalidException - Attempting operation on an invalidated TcCom Object

throws

TcComToRawException - An error occurred when parsing values to Data

throws

TcComDataWriteException - An error occurred when writing the Symbol Data

throws

TcBindingOutOfRangeException - Attempted to write a value to a non-existent field

throws

TcBindingInvalidTypeException - Type-mismatch occurred when parsing Values to Data

throws

TcBindingReadOnlyException - Attempted to write to a ReadOnly Symbol

Parameters
- value: string
  
  The string enum value that is to be written to the Target PLC Symbol
Returns Promise<string>
- The value which was written to the Target PLC Symbol

$subscribe

$subscribe(sampling?: number): Promise<void>

Inherited from TcSymbol.$subscribe
- Defined in src/tc-symbol.ts:197
Activates value change detection of the Target PLC Symbol. The sampling rate can be explicitly set, in case the value changes uneseceraly too fast.

throws

TcBindingIsInvalidException - Attempting operation on an invalidated TcBinding

throws

TcComIsInvalidException - Attempting operation on an invalidated TcCom Object

throws

TcComSubscribeException - An error occurred when subscribing to the Symbol

Parameters
- Default value sampling: number = 10
  
  The speed at which change in the Target PLC Symbol value is detected
Returns Promise<void>

$unsubscribe

$unsubscribe(): Promise<void>

Inherited from TcSymbol.$unsubscribe
- Defined in src/tc-symbol.ts:215
Deactivated value change detection of the Target PLC Symbol. Does not remove the event handlers though, they simply will not be invoked.

throws

TcBindingIsInvalidException - Attempting operation on an invalidated TcBinding

throws

TcComIsInvalidException - Attempting operation on an invalidated TcCom Object

throws

TcComUnsubscribeException - An error occurred when unsubscribing for a Symbol

Returns Promise<void>

Protected __invalidate

__invalidate(): void

Inherited from TcSymbol.__invalidate
- Defined in src/tc-symbol.ts:310
Invalidates the TcBindingof this symbol, as well as, if a callback as provided in case of invalidation - will invoke it

Returns void

Hierarchy

Indexable

Index

Constructors

Events

Accessors

Methods

Constructors

constructor

Parameters

path: string

parent: TcSymbol

pointer: TcSymbolPointer

params: TcEnumType

Default value debug: boolean = false

Returns TcEnumSymbol

Events

$on

Parameters

event: "set"

listener: (e: TcSymbolSetEvent) => void

Parameters

e: TcSymbolSetEvent

Returns void

Returns TcSymbol

Parameters

event: "get"

listener: (e: TcSymbolGetEvent) => void

Parameters

e: TcSymbolGetEvent

Returns void

Returns TcSymbol

Parameters

event: "cleared"

listener: (e: TcSymbolClearedEvent) => void

Parameters

e: TcSymbolClearedEvent

Returns void

Returns TcSymbol

Parameters

event: "changed"

listener: (e: TcSymbolChangedEvent) => void

Parameters

e: TcSymbolChangedEvent

Returns void

Returns TcSymbol

Accessors

$binding

Returns TcEnumBinding

$fields

Returns string[]

$get

Returns Promise<string>

$parent

Returns TcSymbol | undefined

$path

Returns string

$readOnly

Returns boolean

Methods

$clear

Returns Promise<void>

$off

Parameters

eventName: string

listener: (e: any) => void

Parameters

e: any

Returns void

Returns TcSymbol

$onInvalidated

Parameters

callback: (symbol: TcSymbol) => void

Parameters

symbol: TcSymbol

Returns void

Returns void

$once

Parameters

eventName: string