Class DependencyNode

Represents a node in the dependency tree.

Hierarchy

DependencyNode
- DependencyNodeWithCache

Implements

Interfaces.DependencyNode

Index

Constructors

Properties

nodeDependants nodeDependencies

Accessors

deepDependants deepDependencies dependants dependencies

Methods

exists getDeepDependantsDFS getDeepDependenciesDFS registerDependant registerDependency update

Constructors

constructor

new DependencyNode(parameters): Objects.DependencyNode
Parameters
- parameters: {
  dependencies: Iterable<Interfaces.DependencyNode>;
  }
  - Readonly dependencies: Iterable<Interfaces.DependencyNode>
Returns Objects.DependencyNode
- Defined in src/geometryObjects/dependencyNode.ts:13

Properties

`Private` `Readonly` nodeDependants

nodeDependants: Set<Interfaces.DependencyNode> = ...

`Private` `Readonly` nodeDependencies

nodeDependencies: Set<Interfaces.DependencyNode> = ...

Accessors

deepDependants

get deepDependants(): Iterable<Interfaces.DependencyNode>
All the nodes that depend on this node, and all the nodes that those nodes depend on, and so on. Uses a depth-first search.

Returns Iterable<Interfaces.DependencyNode>
Implementation of DependencyNode.deepDependants
- Defined in src/geometryObjects/dependencyNode.ts:71

deepDependencies

get deepDependencies(): Iterable<Interfaces.DependencyNode>
All the nodes that this node depends on, and all the nodes that depend on those nodes, and so on. Uses a depth-first search.

Returns Iterable<Interfaces.DependencyNode>
Implementation of DependencyNode.deepDependencies
- Defined in src/geometryObjects/dependencyNode.ts:68

dependants

get dependants(): Iterable<Interfaces.DependencyNode>
All the nodes that depend on this node.

Returns Iterable<Interfaces.DependencyNode>
Implementation of DependencyNode.dependants
- Defined in src/geometryObjects/dependencyNode.ts:64

dependencies

get dependencies(): Iterable<Interfaces.DependencyNode>
All the nodes that this node depends on.

Returns Iterable<Interfaces.DependencyNode>
Implementation of DependencyNode.dependencies
- Defined in src/geometryObjects/dependencyNode.ts:61

Methods

exists

exists(): boolean
Returns true if the node exists, false otherwise.
false is returned when a node, that normally exists, encounters a special case where it does not exist.

Returns boolean
Implementation of DependencyNode.exists
- Defined in src/geometryObjects/dependencyNode.ts:75

`Private` getDeepDependantsDFS

getDeepDependantsDFS(): Iterable<Interfaces.DependencyNode>
Returns Iterable<Interfaces.DependencyNode>
- Defined in src/geometryObjects/dependencyNode.ts:38

`Private` getDeepDependenciesDFS

getDeepDependenciesDFS(): Iterable<Interfaces.DependencyNode>
Returns Iterable<Interfaces.DependencyNode>
- Defined in src/geometryObjects/dependencyNode.ts:25

registerDependant

registerDependant(dependant): void
Registers a new dependant
Parameters
- dependant: Interfaces.DependencyNode
  
  The node that depends on this node.
Returns void
Implementation of DependencyNode.registerDependant
- Defined in src/geometryObjects/dependencyNode.ts:57

`Protected` registerDependency

registerDependency(dependency): void
Parameters
- dependency: Interfaces.DependencyNode
Returns void
- Defined in src/geometryObjects/dependencyNode.ts:20

update

update(): void
Updates the node and all the nodes that depend on it.

Returns void
Implementation of DependencyNode.update
- Defined in src/geometryObjects/dependencyNode.ts:51

Generated using TypeDoc