Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AssociateEventData

Defines event data format to associate or disassociate an IO source with an IO actor.

Hierarchy

  • CommunicationEventData
    • AssociateEventData

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new AssociateEventData(ioSourceId: string, ioActorId: string, associatingRoute: string, isExternalRoute?: boolean, updateRate?: number): AssociateEventData

  • Create a new AssociateEventData instance.

    Parameters

    • ioSourceId: string

      the object Id of the IO source object to associate/disassociate

    • ioActorId: string

      the object Id of the IO actor object to associate/disassociate

    • associatingRoute: string

      the IO route used by IO source for publishing and by IO actor for subscribing, or undefined if used for disassocation

    • Optional isExternalRoute: boolean

      indicates whether the associating route is external (optional)

    • Optional updateRate: number

      The recommended update rate (in millis) for publishing IO source values (optional)

    Returns AssociateEventData

Accessors

associatingRoute

  • get associatingRoute(): string

  • The IO route associating the given IO source and IO actor, or undefined if the association between IO source and actor should be dissolved.

    Returns string

ioActorId

  • get ioActorId(): string

ioSourceId

  • get ioSourceId(): string

isExternalRoute

  • get isExternalRoute(): boolean

  • Indicates whether the associating route represents an external topic, as specified by IoPoint.externalRoute (optional).

    Only used for association, not for disassociation.

    Returns boolean

updateRate

  • get updateRate(): number

  • The recommended update rate (in millis) for publishing IO source values (optional).

    Only used for association, not for disassociation.

    Returns number

Methods

toJsonObject

  • toJsonObject(): { associatingRoute: string; ioActorId: string; ioSourceId: string; updateRate: number }

  • Returns { associatingRoute: string; ioActorId: string; ioSourceId: string; updateRate: number }

    • associatingRoute: string
    • ioActorId: string
    • ioSourceId: string
    • updateRate: number

Static createFrom

Generated using TypeDoc