Home Manual Reference Source Test
import Node from 'atscm/src/lib/model/Node.ts'
public class | source

Node

Direct Subclass:

ServerNode, SourceNode

The main model class.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Creates a new node.

Member Summary

Public Members
public get

arrayType: ItemOf

The node's array type.

public get

dataType: ItemOf

The node's data type.

public
public get

The node's file path.

public get

true at the moment.

public

idName: *

public get

If the node is an object display.

public get

If the node is a display script.

public get

If the node is a quickdynamic.

public get

If the node is a serverside script.

public get

If the node is a variable.

public get

metadata: NodeDefinition

The metadata to store in the node's definition file.

public get

The node's modellingRule if given.

public
public get

The node's id.

public

parent: *

public get

If the parent resolves metadata (for example: split transformer source files).

public

The node's references.

public get

The node's type definition if given.

Private Members
private get

The node's file path, used to compute Node#filePath.

private get

The node's id, used to compute Node#nodeId.

private

If the parent node resolves metadata.

private

A set of resolved properties.

private

The node's unresolved refernces.

private
private

The node's resolved refernces.

Method Summary

Public Methods
public

addReference(type: ReferenceType, id: string): undefined

Adds a new reference.

public

createChild(undefined: undefined): Node

Creates a new child node.

public

Returns true if the node has the given type definition.

public

hasUnresolvedReference(name: ReferenceTypeName): boolean

public

isResolved(key: NodeResolveKey): boolean

public
public

markAllReferencesAsResolved(name: ReferenceTypeName): undefined

public

markAsResolved(key: NodeResolveKey): undefined

public

markReferenceAsResolved(name: ReferenceTypeName, value: string): undefined

public

setReferences(type: ReferenceType, ids: undefined): undefined

Public Constructors

public constructor(options: Object) source

Creates a new node.

Params:

NameTypeAttributeDescription
options Object

The options to use.

options.name string

The node's name.

options.parent Node

The node's parent node.

options.nodeClass node-opcua~NodeClass

The node's class.

Public Members

public get arrayType: ItemOf source

The node's array type.

public get dataType: ItemOf source

The node's data type.

public fileName: * source

public get filePath: undefined source

The node's file path.

public get hasUnresolvedMetadata: boolean source

true at the moment.

public idName: * source

public get isDisplay: boolean source

If the node is an object display.

public get isDisplayScript: boolean source

If the node is a display script.

public get isQuickDynamic: boolean source

If the node is a quickdynamic.

public get isScript: boolean source

If the node is a serverside script.

public get isVariable: boolean source

If the node is a variable.

public get metadata: NodeDefinition source

The metadata to store in the node's definition file.

public get modellingRule: undefined source

The node's modellingRule if given.

public nodeClass: * source

public get nodeId: string source

The node's id.

public parent: * source

public get parentResolvesMetadata: boolean source

If the parent resolves metadata (for example: split transformer source files).

public references: * source

The node's references.

public get typeDefinition: undefined source

The node's type definition if given.

Private Members

private get _filePath: undefined source

The node's file path, used to compute Node#filePath.

private get _nodeId: undefined source

The node's id, used to compute Node#nodeId.

private _parentResolvesMetadata: boolean source

If the parent node resolves metadata.

private _resolved: * source

A set of resolved properties.

private _resolvedReferences: * source

The node's unresolved refernces.

private _unresolved: * source

private _unresolvedReferences: * source

The node's resolved refernces.

Public Methods

public addReference(type: ReferenceType, id: string): undefined source

Adds a new reference.

Params:

NameTypeAttributeDescription
type ReferenceType
id string

Return:

undefined

public createChild(undefined: undefined): Node source

Creates a new child node.

Params:

NameTypeAttributeDescription
undefined undefined

Return:

Node

public hasTypeDefinition(typeDefName: undefined): boolean source

Returns true if the node has the given type definition.

Params:

NameTypeAttributeDescription
typeDefName undefined

Return:

boolean

public hasUnresolvedReference(name: ReferenceTypeName): boolean source

Params:

NameTypeAttributeDescription
name ReferenceTypeName

Return:

boolean

public isResolved(key: NodeResolveKey): boolean source

Params:

NameTypeAttributeDescription
key NodeResolveKey

Return:

boolean

public isVariableNode(): undefined source

Return:

undefined

public markAllReferencesAsResolved(name: ReferenceTypeName): undefined source

Params:

NameTypeAttributeDescription
name ReferenceTypeName

Return:

undefined

public markAsResolved(key: NodeResolveKey): undefined source

Params:

NameTypeAttributeDescription
key NodeResolveKey

Return:

undefined

public markReferenceAsResolved(name: ReferenceTypeName, value: string): undefined source

Params:

NameTypeAttributeDescription
name ReferenceTypeName
value string

Return:

undefined

public setReferences(type: ReferenceType, ids: undefined): undefined source

Params:

NameTypeAttributeDescription
type ReferenceType
ids undefined

Return:

undefined