Class Class<D, S>

The class with functionality for the base edge type.

Type Parameters

D extends ControlFlowEdge.Data = ControlFlowEdge.Data
S extends ControlFlowEdge.ScratchData = ControlFlowEdge.ScratchData

Hierarchy (View Summary)

BaseEdge.Class<D, S>
- Class
  - ConditionalEdge.Class

Index

Accessors

codirectedEdges data graph id isFake isLoop isRemoved parallelEdges scratchData source target

Methods

as expect init is remove restore switch toCollection toCy tryAs

Accessors

codirectedEdges

get codirectedEdges(): EdgeCollection<this, D, S>
Returns EdgeCollection<this, D, S>
The edges that connect the same nodes as this edge. Direction is taken into account.
Inherited from BaseEdge.Class.codirectedEdges
- Defined in flow/src/graph/BaseEdge.ts:130

data

get data(): D
Use the data object for JSON serializable data. For temporary or non-serializable data, use BaseEdge.Class.scratchData.

Returns D
the data object associated with this edge.
Inherited from BaseEdge.Class.data
- Defined in flow/src/graph/BaseEdge.ts:55

graph

get graph(): BaseGraph.Class
Returns BaseGraph.Class
the graph that this edge is a part of.
Inherited from BaseEdge.Class.graph
- Defined in flow/src/graph/BaseEdge.ts:323

id

get id(): string
Returns string
the unique identifier of this edge.
Inherited from BaseEdge.Class.id
- Defined in flow/src/graph/BaseEdge.ts:77

isFake

get isFake(): boolean
Returns boolean
Whether this edge is ControlFlowEdge.Data.isFake | fake.
- Defined in flow/src/flow/ControlFlowEdge.ts:20
set isFake(value: boolean): void
Sets whether this edge is ControlFlowEdge.Data.isFake | fake.
Parameters
- value: boolean
  Whether this edge is fake.
Returns void
- Defined in flow/src/flow/ControlFlowEdge.ts:29

isLoop

get isLoop(): boolean
Returns boolean
whether this edge is a loop (source and target are the same node).
Inherited from BaseEdge.Class.isLoop
- Defined in flow/src/graph/BaseEdge.ts:283

isRemoved

get isRemoved(): boolean
Returns boolean
whether this edge has been removed from the graph.
Inherited from BaseEdge.Class.isRemoved
- Defined in flow/src/graph/BaseEdge.ts:297

parallelEdges

get parallelEdges(): EdgeCollection<this, D, S>
Returns EdgeCollection<this, D, S>
The edges that connect the same nodes as this edge. Direction is not taken into account.
Inherited from BaseEdge.Class.parallelEdges
- Defined in flow/src/graph/BaseEdge.ts:117

scratchData

get scratchData(): S
Use the scratch data object for temporary or non-serializable data. For JSON serializable data, use BaseEdge.Class.data.

The scratch data is stored under the @specs-feup/flow namespace.

Returns S
the scratch data object associated with this edge.
Inherited from BaseEdge.Class.scratchData
- Defined in flow/src/graph/BaseEdge.ts:67

source

get source(): BaseNode.Class
Returns BaseNode.Class
the source node of this edge.
Inherited from BaseEdge.Class.source
- Defined in flow/src/graph/BaseEdge.ts:84
set source(node: BaseNode.Class): void
Changes the source node of this edge.
Parameters
- node: BaseNode.Class
  The new source node.
Returns void
Inherited from BaseEdge.Class.source
- Defined in flow/src/graph/BaseEdge.ts:93

target

get target(): BaseNode.Class
Returns BaseNode.Class
the target node of this edge.
Inherited from BaseEdge.Class.target
- Defined in flow/src/graph/BaseEdge.ts:100
set target(node: BaseNode.Class): void
Changes the target node of this edge.
Parameters
- node: BaseNode.Class
  The new target node.
Returns void
Inherited from BaseEdge.Class.target
- Defined in flow/src/graph/BaseEdge.ts:109

Methods

as

as<E extends BaseEdge.Class<D, S>>(EdgeType: { Class: Edge.Class<D, S, E> }): E
Changes the functionality class of the current edge. This is only possible if the data and scratch data are compatible with the new class. To assert that, use BaseEdge.Class.is.
Type Parameters
- E extends BaseEdge.Class<D, S>
Parameters
- EdgeType: { Class: Edge.Class<D, S, E> }
  The edge type to change the functionality class into.
Returns E
The same edge, wrapped in the new functionality class.
Inherited from Class.as
- Defined in flow/src/graph/BaseEdge.ts:201

expect

expect<
    D2 extends BaseEdge.Data,
    S2 extends BaseEdge.ScratchData,
    E2 extends BaseEdge.Class<D2, S2>,
>(
    EdgeType: Edge<D2, S2, E2>,
    message?: string,
): E2
Changes the functionality class of the current edge. Should only be used when it is known (but not statically provable) that the edge is compatible with the new class. If not, an error will be thrown.

It is bad practice to try and catch the error thrown by this function. For such cases, combine BaseEdge.Class.is with BaseEdge.Class.as, or use BaseEdge.Class.switch instead.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
- E2 extends BaseEdge.Class<D2, S2>
Parameters
- EdgeType: Edge<D2, S2, E2>
  The edge type to change the functionality class into.
- Optionalmessage: string
  The message to throw if the edge is not compatible with the type.
Returns E2
The edge, wrapped in the new functionality class.

Throws
LaraFlowError if the edge is not compatible with the type. This error should be seen as a logic error and not catched.
Inherited from Class.expect
- Defined in flow/src/graph/BaseEdge.ts:227

init

init<D2 extends BaseEdge.Data, S2 extends BaseEdge.ScratchData>(
builder: Edge.Builder<D2, S2, D, S>,
): BaseEdge.Class<D2, S2>
Initializes the edge with the information of a builder. This is effectively extends the type of the edge to include the data and scratch data of the builder.

The same edge may simultaneously be of multiple types, as long as the data and scratch data are compatible with the types. The builder methods may overwrite data and scratch data fields with names that collide with its type's fields.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
Parameters
- builder: Edge.Builder<D2, S2, D, S>
  The builder to use to initialize the edge.
Returns BaseEdge.Class<D2, S2>
The same edge, with the data and scratch data of the builder. The edge is downcasted to BaseEdge.Class because the builder may overwrite the data and scratch data fields, invalidating the current type.
Inherited from Class.init
- Defined in flow/src/graph/BaseEdge.ts:152

is

is<
    D2 extends BaseEdge.Data,
    S2 extends BaseEdge.ScratchData,
    E2 extends BaseEdge.Class<D2, S2>,
>(
    EdgeType: Edge<D2, S2, E2>,
): this is BaseEdge.Class<D2, S2>
Checks if this edge's data and scratch data are compatible with a specific type. This is effectively a type guard function.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
- E2 extends BaseEdge.Class<D2, S2>
Parameters
- EdgeType: Edge<D2, S2, E2>
  The edge type to check compatibility with.
Returns this is BaseEdge.Class<D2, S2>
Whether the edge is compatible with the given type.
Inherited from Class.is
- Defined in flow/src/graph/BaseEdge.ts:175

remove

remove(): void
Removes this edge from the graph.

Returns void
Inherited from Class.remove
- Defined in flow/src/graph/BaseEdge.ts:290

restore

restore(): void
Restores this edge if it has been removed. See BaseEdge.Class.remove.

Returns void
Inherited from Class.restore
- Defined in flow/src/graph/BaseEdge.ts:304

switch

switch(
    ...cases: _Case<
        BaseEdge.Data,
        BaseEdge.ScratchData,
        BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>,
    >[],
): void
Checks if the type of the edge is compatible with several types, calling a callback for the first match. See Edge.Case for the syntax of each case.

For a default case, match with BaseEdge, which will always be compatible with any edge type.
Parameters
- ...cases: _Case<
      BaseEdge.Data,
      BaseEdge.ScratchData,
      BaseEdge.Class<BaseEdge.Data, BaseEdge.ScratchData>,
  >[]
  The cases to match against.
Returns void
Inherited from Class.switch
- Defined in flow/src/graph/BaseEdge.ts:271

toCollection

toCollection(): EdgeCollection<ControlFlowEdge.Class<D, S>, D, S>
Returns EdgeCollection<ControlFlowEdge.Class<D, S>, D, S>
A collection containing only this edge.
Inherited from Class.toCollection
- Defined in flow/src/graph/BaseEdge.ts:311

toCy

toCy(): EdgeSingular
Returns EdgeSingular
the underlying cytoscape edge object.
Inherited from Class.toCy
- Defined in flow/src/graph/BaseEdge.ts:330

tryAs

tryAs<
    D2 extends BaseEdge.Data,
    S2 extends BaseEdge.ScratchData,
    E2 extends BaseEdge.Class<D2, S2>,
>(
    EdgeType: Edge<D2, S2, E2>,
): E2 | undefined
Tries to change the functionality class of the current edge. If the edge is not compatible with the new class, undefined is returned.
Type Parameters
- D2 extends BaseEdge.Data
- S2 extends BaseEdge.ScratchData
- E2 extends BaseEdge.Class<D2, S2>
Parameters
- EdgeType: Edge<D2, S2, E2>
  The edge type to change the functionality class into.
Returns E2 | undefined
The edge, wrapped in the new functionality class, or undefined if the edge is not compatible with the type.
Inherited from Class.tryAs
- Defined in flow/src/graph/BaseEdge.ts:250

Class Class<D, S>

Type Parameters

Hierarchy (View Summary)

Index

Accessors

Methods

Accessors

codirectedEdges

Returns EdgeCollection<this, D, S>

data

Returns D

graph

Returns BaseGraph.Class

id

Returns string

isFake

Returns boolean

Parameters

Returns void

isLoop

Returns boolean

isRemoved

Returns boolean

parallelEdges

Returns EdgeCollection<this, D, S>

scratchData

Returns S

source

Returns BaseNode.Class

Parameters

Returns void

target

Returns BaseNode.Class

Parameters

Returns void

Methods

as

Type Parameters

Parameters

Returns E

expect

Type Parameters

Parameters

Returns E2

Throws

init

Type Parameters

Parameters

Returns BaseEdge.Class<D2, S2>

is

Type Parameters

Parameters

Returns this is BaseEdge.Class<D2, S2>

remove

Returns void

restore

Returns void

switch

Parameters

Returns void

toCollection

Returns EdgeCollection<ControlFlowEdge.Class<D, S>, D, S>

toCy

Returns EdgeSingular

tryAs

Type Parameters

Parameters

Returns E2 | undefined

Settings

On This Page