@haxall/haxall
    Preparing search index...

    Class ConnPoint

    ConnPoint models a point within a connector.

    Hierarchy (View Summary)

    Implements

    • HxConnPoint
    Index

    Constructors

    Properties

    type$: Type

    Methods

    • Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:

      this < that   =>  <0
      this == that => 0
      this > that => >0

      This method may also be accessed via the < <= <=> >= and > shortcut operators. If not overridden the default implementation compares the toStr representations. Also see docLang.

      Examples:

      3.compare(8)  =>  -1
      8.compare(3) => 1
      8.compare(8) => 0
      3 <=> 8 => -1 // shortcut for 3.compare(8)

      Parameters

      Returns number

    • Parent connector

      Returns Conn

    • Current address tag value if configured on the point

      Returns JsObj

    • Library specific point data. This value is managed by the connector actor via ConnDispatch.setPointData.

      Returns JsObj

    • Debug details

      Returns string

    • Display name

      Returns string

    • Compare this object to the specified for equality. This method may be accessed via the == and != shortcut operators. If not overridden the default implementation compares for reference equality using the === operator. If this method is overridden, then hash() must also be overridden such that any two objects which return true for equals() must return the same value for hash(). This method must accept null and return false.

      Parameters

      Returns boolean

    • Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.

      Returns number

    • History address tag value if configured on the point

      Returns JsObj

    • Record id

      Returns Ref

    • Is current address enabled on this point. This returns true only when all the of following conditions are met:

      • the connector supports current values
      • this point has a cur address tag configured
      • the address tag value is of the proper type
      • the point is not disabled

      Returns boolean

    • Does the record have the disabled marker configured

      Returns boolean

    • Is the record missing disabled marker configured

      Returns boolean

    • Is history address supported on this point. This returns true only when all the of following conditions are met:

      • the connector supports history synchronization
      • this point has a his address tag configured
      • the address tag value is of the proper type
      • the point is not disabled

      Returns boolean

    • Return if this Obj is immutable and safe to share between threads:

      • an instance of a const class
      • the result of toImmutable on List, Map, or Buf
      • a Func object may or may not be immutable - see sys::Func.
      • other instances are assumed mutable and return false

      Returns boolean

    • Is this point currently in one or more watches

      Returns boolean

    • Is write address enabled on this point. This returns true only when all the of following conditions are met:

      • the connector supports writable points
      • this point has a write address tag configured
      • the address tag value is of the proper type
      • the point is not disabled

      Returns boolean

    • Point kind defined by rec kind tag

      Returns Kind

    • Parent connector library

      Returns ConnLib

    • Current version of the record. This dict only represents the current persistent tags. It does not track transient changes such as curVal and curStatus.

      Returns Dict

    • Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:

      • if type is const, return this
      • if already an immutable List, Map, Buf, or Func return this
      • if a List, then attempt to perform a deep clone by calling toImmutable on all items
      • if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
      • some Funcs can be made immutable - see sys::Func
      • if a Buf create immutable copy, see sys::Buf
      • any other object throws NotImmutableErr

      Returns Readonly<this>

    • Debug string

      Returns string

    • Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:

      a->x        a.trap("x", null)
      a->x() a.trap("x", null)
      a->x = b a.trap("x", [b])
      a->x(b) a.trap("x", [b])
      a->x(b, c) a.trap("x", [b, c])

      The default implementation provided by Obj attempts to use reflection. If name maps to a method, it is invoked with the specified arguments. If name maps to a field and args.size is zero, get the field. If name maps to a field and args.size is one, set the field and return args[0]. Otherwise throw UnknownSlotErr.

      Parameters

      Returns JsObj

    • Conn tuning configuration to use for this point

      Returns ConnTuning

    • Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

      Returns Type

    • Timezone defined by rec tz tag

      Returns TimeZone

    • Unit defined by rec unit tag or null

      Returns Unit

    • Put point into down/fault/remoteErr with given error.

      Parameters

      Returns void

    • Update current value and status

      Parameters

      Returns void

    • Update his sync with given error

      Parameters

      Returns JsObj

    • Write new history items and update status. Span should be same value passed to onSyncHis. The items will be normalized, clipped by span, converted by hisConvert if configured, and then and written to historian.

      Parameters

      Returns JsObj

    • Update write status down/fault with given error

      Parameters

      Returns void

    • Update write value and status

      Parameters

      Returns void

    • This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

      Parameters

      • f: (arg0: this) => void

      Returns this

    • Write address tag value if configured on the point

      Returns JsObj

    • Write x.toStr to standard output followed by newline. If x is null then print "null". If no argument is provided then print an empty line.

      Parameters

      Returns void