Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "tc-symbol"

Module, which contains the definitions of all the TcSymbols and their derived types, through which data manipulation with the Target PLC is made. The TcSymbols act as the interface between the TcContext and the TcBindings, where the TcBindings manage all the data parsing, checking and Symbol memory location, while the TcSymbol itself, as a wrapper for those bindings and collection of children Symbols.

Licensed under MIT License.

Copyright (c) 2020 Dmitrij Trifanov d.v.trifanov@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

Type aliases

TcSymbolMethod

TcSymbolMethod: (args: any) => Promise<{ outputs?: any; result: any }>

Invokes a Rpc Method of a Function_Block, with the provided arguments

param

All the arguments, as an object, that are passed to the method

throws

TcComIsInvalidException - Attempted to use an Invalid TcCom Object for subscription

throws

TcComMethodCallException - Failed to call the Rpc Method on the PLC Side

returns

The result of the method call

Type declaration

    • (args: any): Promise<{ outputs?: any; result: any }>
    • Parameters

      • args: any

      Returns Promise<{ outputs?: any; result: any }>

Generated using TypeDoc