import {Link} from './core/core_link.js'

public class | source

Link

Extends:

cables-shared-client~Events → Link

A link is a connection between two ports: one input and one output port.

Static Member Summary

Static Public Members
public static	EVENT_UNLINK: *

Static Method Summary

Static Public Methods
public static	canLink(p1: Port, p2: Port): Boolean return true if ports can be linked
public static	canLinkText(p1: Port, p2: Port): string return a text message with human readable reason if ports can not be linked, or can be

Constructor Summary

Public Constructor
public	constructor(p: Patch)

Member Summary

Public Members
public	activityCounter: number
public	id: *
public	ignoreInSerialize: boolean
public	portIn: Port
public	portOut: Port

Private Members
private	_patch: Patch
private	log: *

Method Summary

Public Methods
public	activity()
public	getOtherPort(p: Port): * Returns the port of the link that is not the given port.
public	getSerialized(): *
public	link(p1: Port, p2: Port): boolean Links the two ports.
public	remove() Unlinks/removes this link from both ports.
public	setValue(v: any)

Private Methods
private	_setValue()

Static Public Members

public static EVENT_UNLINK: * source

Static Public Methods

public static canLink(p1: Port, p2: Port): Boolean source

return true if ports can be linked

Params:

Name	Type	Attribute	Description
p1	Port		port1
p2	Port		port2

Return:

Boolean

public static canLinkText(p1: Port, p2: Port): string source

return a text message with human readable reason if ports can not be linked, or can be

Params:

Name	Type	Attribute	Description
p1	Port		port1
p2	Port		port2

Return:

string

Public Constructors

public constructor(p: Patch) source

Params:

Name	Type	Attribute	Description
p	Patch

Public Members

public activityCounter: number source

public id: * source

public ignoreInSerialize: boolean source

public portIn: Port source

public portOut: Port source

Private Members

private _patch: Patch source

private log: * source

Public Methods

public activity() source

public getOtherPort(p: Port): * source

Returns the port of the link that is not the given port.

Params:

Name	Type	Attribute	Description
p	Port		port

Return:

public getSerialized(): * source

Return:

public link(p1: Port, p2: Port): boolean source

Links the two ports.

Params:

Name	Type	Attribute	Description
p1	Port		port1
p2	Port		port2

Return:

boolean

public remove() source

Unlinks/removes this link from both ports.

public setValue(v: any) source

Params:

Name	Type	Attribute	Description
v	any

Link

Extends:

Static Member Summary

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Static Public Members

public static EVENT_UNLINK: * source

Static Public Methods

public static canLink(p1: Port, p2: Port): Boolean source

Params:

Return:

public static canLinkText(p1: Port, p2: Port): string source

Params:

Return:

Public Constructors

public constructor(p: Patch) source

Params:

Public Members

public activityCounter: number source

public id: * source

public ignoreInSerialize: boolean source

public portIn: Port source

public portOut: Port source

Private Members

private _patch: Patch source

private log: * source

Public Methods

public activity() source

public getOtherPort(p: Port): * source

Params:

Return:

public getSerialized(): * source

Return:

public link(p1: Port, p2: Port): boolean source

Params:

Return:

public remove() source

public setValue(v: any) source

Params:

Private Methods

private _setValue() source