node-opcua-address-space-base 2.76.0 → 2.76.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/address_space.d.ts +168 -168
- package/dist/address_space.js +2 -2
- package/dist/base_node.d.ts +186 -186
- package/dist/base_node.js +3 -3
- package/dist/bind_variable.d.ts +52 -52
- package/dist/bind_variable.js +2 -2
- package/dist/clone_options.d.ts +44 -44
- package/dist/clone_options.js +18 -18
- package/dist/continuation_point.d.ts +2 -2
- package/dist/continuation_point.js +2 -2
- package/dist/event_notifier_flags.d.ts +7 -7
- package/dist/event_notifier_flags.js +11 -11
- package/dist/i_event_data.d.ts +17 -17
- package/dist/i_event_data.js +2 -2
- package/dist/index.d.ts +23 -23
- package/dist/index.js +39 -39
- package/dist/instantiate_options.d.ts +80 -80
- package/dist/instantiate_options.js +2 -2
- package/dist/modelling_rule_type.d.ts +1 -1
- package/dist/modelling_rule_type.js +2 -2
- package/dist/namespace.d.ts +279 -279
- package/dist/namespace.js +2 -2
- package/dist/session_context.d.ts +51 -51
- package/dist/session_context.js +2 -2
- package/dist/ua_data_type.d.ts +32 -32
- package/dist/ua_data_type.js +2 -2
- package/dist/ua_dynamic_variable_array.d.ts +12 -12
- package/dist/ua_dynamic_variable_array.js +2 -2
- package/dist/ua_event_type.d.ts +3 -3
- package/dist/ua_event_type.js +2 -2
- package/dist/ua_method.d.ts +41 -41
- package/dist/ua_method.js +4 -4
- package/dist/ua_object.d.ts +131 -131
- package/dist/ua_object.js +2 -2
- package/dist/ua_object_type.d.ts +27 -27
- package/dist/ua_object_type.js +2 -2
- package/dist/ua_property.d.ts +16 -16
- package/dist/ua_property.js +2 -2
- package/dist/ua_reference.d.ts +12 -12
- package/dist/ua_reference.js +2 -2
- package/dist/ua_reference_type.d.ts +18 -18
- package/dist/ua_reference_type.js +3 -3
- package/dist/ua_variable.d.ts +285 -285
- package/dist/ua_variable.js +2 -2
- package/dist/ua_variable_t.d.ts +15 -15
- package/dist/ua_variable_t.js +2 -2
- package/dist/ua_variable_type.d.ts +39 -39
- package/dist/ua_variable_type.js +3 -3
- package/dist/ua_view.d.ts +7 -7
- package/dist/ua_view.js +2 -2
- package/package.json +14 -14
package/dist/namespace.d.ts
CHANGED
|
@@ -1,279 +1,279 @@
|
|
|
1
|
-
import { QualifiedNameLike, AccessRestrictionsFlag, LocalizedTextLike } from "node-opcua-data-model";
|
|
2
|
-
import { NodeId, NodeIdLike } from "node-opcua-nodeid";
|
|
3
|
-
import { ArgumentOptions, AxisInformationOptions, AxisScaleEnumeration, EnumFieldOptions, EUInformationOptions, RangeOptions, RolePermissionType, RolePermissionTypeOptions, StructureFieldOptions } from "node-opcua-types";
|
|
4
|
-
import { VariantLike } from "node-opcua-variant";
|
|
5
|
-
import { UInt32 } from "node-opcua-basic-types";
|
|
6
|
-
import { DataValueOptions } from "node-opcua-data-value";
|
|
7
|
-
import { IAddressSpace } from "./address_space";
|
|
8
|
-
import { AddReferenceOpts, BaseNode, ConstructNodeIdOptions } from "./base_node";
|
|
9
|
-
import { ModellingRuleType } from "./modelling_rule_type";
|
|
10
|
-
import { UADataType } from "./ua_data_type";
|
|
11
|
-
import { UAObject } from "./ua_object";
|
|
12
|
-
import { UAObjectType } from "./ua_object_type";
|
|
13
|
-
import { UAReferenceType } from "./ua_reference_type";
|
|
14
|
-
import { UAVariable } from "./ua_variable";
|
|
15
|
-
import { UAVariableType } from "./ua_variable_type";
|
|
16
|
-
import { BindVariableOptions } from "./bind_variable";
|
|
17
|
-
import { UAView } from "./ua_view";
|
|
18
|
-
import { UAEventType } from "./ua_event_type";
|
|
19
|
-
import { UAMethod } from "./ua_method";
|
|
20
|
-
export interface AddBaseNodeOptions {
|
|
21
|
-
browseName: QualifiedNameLike;
|
|
22
|
-
nodeId?: NodeIdLike;
|
|
23
|
-
displayName?: LocalizedTextLike | LocalizedTextLike[];
|
|
24
|
-
description?: LocalizedTextLike;
|
|
25
|
-
componentOf?: NodeIdLike | BaseNode;
|
|
26
|
-
eventSourceOf?: NodeIdLike | BaseNode;
|
|
27
|
-
notifierOf?: NodeIdLike | BaseNode;
|
|
28
|
-
organizedBy?: NodeIdLike | BaseNode;
|
|
29
|
-
propertyOf?: NodeIdLike | BaseNode;
|
|
30
|
-
modellingRule?: ModellingRuleType;
|
|
31
|
-
references?: AddReferenceOpts[];
|
|
32
|
-
/**
|
|
33
|
-
*
|
|
34
|
-
*/
|
|
35
|
-
accessRestrictions?: AccessRestrictionsFlag;
|
|
36
|
-
/**
|
|
37
|
-
*
|
|
38
|
-
*/
|
|
39
|
-
rolePermissions?: RolePermissionTypeOptions[];
|
|
40
|
-
}
|
|
41
|
-
export interface AddObjectTypeOptions extends AddBaseNodeOptions {
|
|
42
|
-
isAbstract?: boolean;
|
|
43
|
-
/**
|
|
44
|
-
* @default BaseObjectType
|
|
45
|
-
*/
|
|
46
|
-
subtypeOf?: string | UAObjectType;
|
|
47
|
-
eventNotifier?: number;
|
|
48
|
-
postInstantiateFunc?: (node: UAObject) => void;
|
|
49
|
-
}
|
|
50
|
-
export interface AddVariableTypeOptions extends AddBaseNodeOptions, VariableStuff {
|
|
51
|
-
isAbstract?: boolean;
|
|
52
|
-
/**
|
|
53
|
-
* @default BaseVariableType
|
|
54
|
-
*/
|
|
55
|
-
subtypeOf?: string | UAVariableType;
|
|
56
|
-
postInstantiateFunc?: (node: UAVariableType) => void;
|
|
57
|
-
value?: VariantLike;
|
|
58
|
-
}
|
|
59
|
-
export interface AddReferenceTypeOptions extends AddBaseNodeOptions {
|
|
60
|
-
isAbstract?: boolean;
|
|
61
|
-
inverseName: string;
|
|
62
|
-
subtypeOf?: string | NodeId | UAReferenceType;
|
|
63
|
-
}
|
|
64
|
-
export interface EnumerationItem {
|
|
65
|
-
description?: LocalizedTextLike;
|
|
66
|
-
displayName: LocalizedTextLike;
|
|
67
|
-
value: number;
|
|
68
|
-
}
|
|
69
|
-
export interface AddEnumerationTypeOptions extends AddBaseNodeOptions {
|
|
70
|
-
enumeration: string[] | EnumerationItem[];
|
|
71
|
-
}
|
|
72
|
-
export interface AddObjectOptions extends AddBaseNodeOptions {
|
|
73
|
-
eventNotifier?: number;
|
|
74
|
-
typeDefinition?: string | NodeId | UAObjectType;
|
|
75
|
-
nodeVersion?: string;
|
|
76
|
-
encodingOf?: NodeId | BaseNode;
|
|
77
|
-
}
|
|
78
|
-
export interface AddViewOptions extends AddBaseNodeOptions {
|
|
79
|
-
typeDefinition?: string | NodeId | UAObjectType;
|
|
80
|
-
}
|
|
81
|
-
export interface AddMethodOptions {
|
|
82
|
-
nodeId?: NodeIdLike;
|
|
83
|
-
browseName: QualifiedNameLike;
|
|
84
|
-
displayName?: LocalizedTextLike;
|
|
85
|
-
description?: LocalizedTextLike;
|
|
86
|
-
inputArguments?: ArgumentOptions[];
|
|
87
|
-
modellingRule?: ModellingRuleType;
|
|
88
|
-
outputArguments?: ArgumentOptions[];
|
|
89
|
-
componentOf?: NodeIdLike | BaseNode;
|
|
90
|
-
executable?: boolean;
|
|
91
|
-
userExecutable?: boolean;
|
|
92
|
-
accessRestrictions?: AccessRestrictionsFlag;
|
|
93
|
-
rolePermissions?: RolePermissionTypeOptions[];
|
|
94
|
-
}
|
|
95
|
-
export declare type AccessLevelString = string;
|
|
96
|
-
export interface VariableStuff {
|
|
97
|
-
dataType?: string | NodeIdLike | UADataType;
|
|
98
|
-
/**
|
|
99
|
-
* This Attribute indicates whether the Value Attribute of the Variable is an array and how many dimensions
|
|
100
|
-
* the array has.
|
|
101
|
-
* It may have the following values:
|
|
102
|
-
* n > 1: the Value is an array with the specified number of dimensions.
|
|
103
|
-
* OneDimension (1): The value is an array with one dimension.
|
|
104
|
-
* OneOrMoreDimensions (0): The value is an array with one or more dimensions.
|
|
105
|
-
* Scalar (?1): The value is not an array.
|
|
106
|
-
* Any (?2): The value can be a scalar or an array with any number of dimensions.
|
|
107
|
-
* ScalarOrOneDimension (?3): The value can be a scalar or a one dimensional array.
|
|
108
|
-
* NOTE All DataTypes are considered to be scalar, even if they have array-like semantics
|
|
109
|
-
* like ByteString and String.
|
|
110
|
-
*/
|
|
111
|
-
valueRank?: UInt32;
|
|
112
|
-
/**
|
|
113
|
-
* This Attribute specifies the length of each dimension for an array value. T
|
|
114
|
-
* The Attribute is intended to describe the capability of the Variable, not the current size.
|
|
115
|
-
* The number of elements shall be equal to the value of the ValueRank Attribute. Shall be null
|
|
116
|
-
* if ValueRank ? 0.
|
|
117
|
-
* A value of 0 for an individual dimension indicates that the dimension has a variable length.
|
|
118
|
-
* For example, if a Variable is defined by the following C array:
|
|
119
|
-
* Int32 myArray[346];
|
|
120
|
-
* then this Variables DataType would point to an Int32, the Variable�s ValueRank has the
|
|
121
|
-
* value 1 and the ArrayDimensions is an array with one entry having the value 346.
|
|
122
|
-
* Note that the maximum length of an array transferred on the wire is 2147483647 (max Int32)
|
|
123
|
-
* and a multi-dimensional array is encoded as a one dimensional array.
|
|
124
|
-
*/
|
|
125
|
-
arrayDimensions?: UInt32[] | null;
|
|
126
|
-
/**
|
|
127
|
-
* The AccessLevel Attribute is used to indicate how the Value of a Variable can be accessed
|
|
128
|
-
* (read/write) and if it contains current and/or historic data. The AccessLevel does not take
|
|
129
|
-
* any user access rights into account, i.e. although the Variable is writable this may be
|
|
130
|
-
* restricted to a certain user / user group.
|
|
131
|
-
*
|
|
132
|
-
* https://reference.opcfoundation.org/v104/Core/docs/Part3/8.57/
|
|
133
|
-
*/
|
|
134
|
-
accessLevel?: UInt32 | AccessLevelString;
|
|
135
|
-
/**
|
|
136
|
-
* The UserAccessLevel Attribute is used to indicate how the Value of a Variable can be accessed
|
|
137
|
-
* (read/write) and if it contains current or historic data taking user access rights into account.
|
|
138
|
-
* https://reference.opcfoundation.org/v104/Core/docs/Part3/8.57/
|
|
139
|
-
*/
|
|
140
|
-
userAccessLevel?: UInt32 | AccessLevelString;
|
|
141
|
-
/**
|
|
142
|
-
* The minimumSamplingInterval Attribute indicates how 'current' the Value of the Variable will
|
|
143
|
-
* be kept.
|
|
144
|
-
* It specifies (in milliseconds) how fast the Server can reasonably sample the value
|
|
145
|
-
* for changes (see Part 4 for a detailed description of sampling interval).
|
|
146
|
-
* A minimumSamplingInterval of 0 indicates that the Server is to monitor the item continuously.
|
|
147
|
-
* A minimumSamplingInterval of -1 means indeterminate.
|
|
148
|
-
*/
|
|
149
|
-
minimumSamplingInterval?: number;
|
|
150
|
-
/**
|
|
151
|
-
* The Historizing Attribute indicates whether the Server is actively collecting data for the
|
|
152
|
-
* history of the Variable.
|
|
153
|
-
* This differs from the AccessLevel Attribute which identifies if the
|
|
154
|
-
* Variable has any historical data. A value of TRUE indicates that the Server is actively
|
|
155
|
-
* collecting data. A value of FALSE indicates the Server is not actively collecting data.
|
|
156
|
-
* Default value is FALSE.
|
|
157
|
-
*/
|
|
158
|
-
historizing?: boolean;
|
|
159
|
-
dataValue?: DataValueOptions;
|
|
160
|
-
}
|
|
161
|
-
export interface AddVariableOptionsWithoutValue extends AddBaseNodeOptions, VariableStuff {
|
|
162
|
-
}
|
|
163
|
-
export interface AddVariableOptions extends AddVariableOptionsWithoutValue {
|
|
164
|
-
typeDefinition?: string | NodeId | UAVariableType;
|
|
165
|
-
value?: BindVariableOptions;
|
|
166
|
-
postInstantiateFunc?: (node: UAVariable) => void;
|
|
167
|
-
}
|
|
168
|
-
export interface CreateDataTypeOptions extends AddBaseNodeOptions {
|
|
169
|
-
isAbstract: boolean;
|
|
170
|
-
subtypeOf?: string | NodeId | UADataType;
|
|
171
|
-
partialDefinition?: StructureFieldOptions[] | EnumFieldOptions[];
|
|
172
|
-
}
|
|
173
|
-
/**
|
|
174
|
-
*
|
|
175
|
-
* @param options.componentOf {NodeId}
|
|
176
|
-
* @param options.browseName {String}
|
|
177
|
-
* @param options.title {String}
|
|
178
|
-
* @param [options.instrumentRange]
|
|
179
|
-
* @param [options.instrumentRange.low] {Double}
|
|
180
|
-
* @param [options.instrumentRange.high] {Double}
|
|
181
|
-
* @param options.engineeringUnitsRange.low {Double}
|
|
182
|
-
* @param options.engineeringUnitsRange.high {Double}
|
|
183
|
-
* @param options.engineeringUnits {String}
|
|
184
|
-
* @param [options.nodeId = {NodeId}]
|
|
185
|
-
* @param options.accessLevel
|
|
186
|
-
* @param options.userAccessLevel
|
|
187
|
-
* @param options.title {String}
|
|
188
|
-
* @param options.axisScaleType {AxisScaleEnumeration}
|
|
189
|
-
*
|
|
190
|
-
* @param options.xAxisDefinition {AxisInformation}
|
|
191
|
-
* @param options.xAxisDefinition.engineeringUnits EURange
|
|
192
|
-
* @param options.xAxisDefinition.range
|
|
193
|
-
* @param options.xAxisDefinition.range.low
|
|
194
|
-
* @param options.xAxisDefinition.range.high
|
|
195
|
-
* @param options.xAxisDefinition.title {LocalizedText}
|
|
196
|
-
* @param options.xAxisDefinition.axisScaleType {AxisScaleEnumeration}
|
|
197
|
-
* @param options.xAxisDefinition.axisSteps = <null> {Array<Double>}
|
|
198
|
-
* @param options.value
|
|
199
|
-
*/
|
|
200
|
-
export interface AddYArrayItemOptions extends AddVariableOptions {
|
|
201
|
-
title: string;
|
|
202
|
-
instrumentRange?: RangeOptions;
|
|
203
|
-
engineeringUnitsRange?: RangeOptions;
|
|
204
|
-
engineeringUnits?: EUInformationOptions;
|
|
205
|
-
axisScaleType: AxisScaleEnumeration | string;
|
|
206
|
-
xAxisDefinition?: AxisInformationOptions;
|
|
207
|
-
}
|
|
208
|
-
export declare type CreateNodeOptions = any;
|
|
209
|
-
export declare interface INamespace {
|
|
210
|
-
version: string;
|
|
211
|
-
publicationDate: Date;
|
|
212
|
-
namespaceUri: string;
|
|
213
|
-
addressSpace: IAddressSpace;
|
|
214
|
-
index: number;
|
|
215
|
-
constructNodeId(options: ConstructNodeIdOptions): NodeId;
|
|
216
|
-
findObjectType(objectType: string): UAObjectType | null;
|
|
217
|
-
findVariableType(variableType: string): UAVariableType | null;
|
|
218
|
-
findDataType(dataType: string): UADataType | null;
|
|
219
|
-
findReferenceType(referenceType: string): UAReferenceType | null;
|
|
220
|
-
findReferenceTypeFromInverseName(referenceType: string): UAReferenceType | null;
|
|
221
|
-
findNode(nodeId: NodeIdLike): BaseNode | null;
|
|
222
|
-
findNode2(nodeId: NodeId): BaseNode | null;
|
|
223
|
-
addAlias(aliasName: string, nodeId: NodeId): void;
|
|
224
|
-
addObjectType(options: AddObjectTypeOptions): UAObjectType;
|
|
225
|
-
addVariableType(options: AddVariableTypeOptions): UAVariableType;
|
|
226
|
-
addReferenceType(options: AddReferenceTypeOptions): UAReferenceType;
|
|
227
|
-
addEnumerationType(options: AddEnumerationTypeOptions): UADataType;
|
|
228
|
-
createDataType(options: CreateDataTypeOptions): UADataType;
|
|
229
|
-
addVariable(options: AddVariableOptions): UAVariable;
|
|
230
|
-
addObject(options: AddObjectOptions): UAObject;
|
|
231
|
-
addView(options: AddViewOptions): UAView;
|
|
232
|
-
addFolder(parentFolder: NodeIdLike | UAObject, options: any): UAObject;
|
|
233
|
-
createNode(options: CreateNodeOptions): BaseNode;
|
|
234
|
-
internalCreateNode(options: CreateNodeOptions): BaseNode;
|
|
235
|
-
deleteNode(node: NodeId | BaseNode): void;
|
|
236
|
-
/**
|
|
237
|
-
* add a new event type to the address space
|
|
238
|
-
* @example
|
|
239
|
-
*
|
|
240
|
-
* const evtType = namespace.addEventType({
|
|
241
|
-
* browseName: "MyAuditEventType",
|
|
242
|
-
* subtypeOf: "AuditEventType"
|
|
243
|
-
* });
|
|
244
|
-
* const myConditionType = namespace.addEventType({
|
|
245
|
-
* browseName: "MyConditionType",
|
|
246
|
-
* subtypeOf: "ConditionType",
|
|
247
|
-
* isAbstract: false
|
|
248
|
-
* });
|
|
249
|
-
*
|
|
250
|
-
*/
|
|
251
|
-
addEventType(options: {
|
|
252
|
-
browseName: QualifiedNameLike;
|
|
253
|
-
/**
|
|
254
|
-
* @default BaseEventType
|
|
255
|
-
*/
|
|
256
|
-
subtypeOf?: string | UAEventType;
|
|
257
|
-
isAbstract?: boolean;
|
|
258
|
-
}): UAEventType;
|
|
259
|
-
/**
|
|
260
|
-
*
|
|
261
|
-
*/
|
|
262
|
-
addMethod(parent: UAObject | UAObjectType, options: AddMethodOptions): UAMethod;
|
|
263
|
-
toNodeset2XML(): string;
|
|
264
|
-
/**
|
|
265
|
-
* @internals
|
|
266
|
-
*/
|
|
267
|
-
getStandardsNodeIds(): {
|
|
268
|
-
referenceTypeIds: {
|
|
269
|
-
[key: string]: string;
|
|
270
|
-
};
|
|
271
|
-
objectTypeIds: {
|
|
272
|
-
[key: string]: string;
|
|
273
|
-
};
|
|
274
|
-
};
|
|
275
|
-
setDefaultRolePermissions(rolePermissions: RolePermissionTypeOptions[] | null): void;
|
|
276
|
-
getDefaultRolePermissions(): RolePermissionType[] | null;
|
|
277
|
-
setDefaultAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
|
|
278
|
-
getDefaultAccessRestrictions(): AccessRestrictionsFlag;
|
|
279
|
-
}
|
|
1
|
+
import { QualifiedNameLike, AccessRestrictionsFlag, LocalizedTextLike } from "node-opcua-data-model";
|
|
2
|
+
import { NodeId, NodeIdLike } from "node-opcua-nodeid";
|
|
3
|
+
import { ArgumentOptions, AxisInformationOptions, AxisScaleEnumeration, EnumFieldOptions, EUInformationOptions, RangeOptions, RolePermissionType, RolePermissionTypeOptions, StructureFieldOptions } from "node-opcua-types";
|
|
4
|
+
import { VariantLike } from "node-opcua-variant";
|
|
5
|
+
import { UInt32 } from "node-opcua-basic-types";
|
|
6
|
+
import { DataValueOptions } from "node-opcua-data-value";
|
|
7
|
+
import { IAddressSpace } from "./address_space";
|
|
8
|
+
import { AddReferenceOpts, BaseNode, ConstructNodeIdOptions } from "./base_node";
|
|
9
|
+
import { ModellingRuleType } from "./modelling_rule_type";
|
|
10
|
+
import { UADataType } from "./ua_data_type";
|
|
11
|
+
import { UAObject } from "./ua_object";
|
|
12
|
+
import { UAObjectType } from "./ua_object_type";
|
|
13
|
+
import { UAReferenceType } from "./ua_reference_type";
|
|
14
|
+
import { UAVariable } from "./ua_variable";
|
|
15
|
+
import { UAVariableType } from "./ua_variable_type";
|
|
16
|
+
import { BindVariableOptions } from "./bind_variable";
|
|
17
|
+
import { UAView } from "./ua_view";
|
|
18
|
+
import { UAEventType } from "./ua_event_type";
|
|
19
|
+
import { UAMethod } from "./ua_method";
|
|
20
|
+
export interface AddBaseNodeOptions {
|
|
21
|
+
browseName: QualifiedNameLike;
|
|
22
|
+
nodeId?: NodeIdLike;
|
|
23
|
+
displayName?: LocalizedTextLike | LocalizedTextLike[];
|
|
24
|
+
description?: LocalizedTextLike;
|
|
25
|
+
componentOf?: NodeIdLike | BaseNode;
|
|
26
|
+
eventSourceOf?: NodeIdLike | BaseNode;
|
|
27
|
+
notifierOf?: NodeIdLike | BaseNode;
|
|
28
|
+
organizedBy?: NodeIdLike | BaseNode;
|
|
29
|
+
propertyOf?: NodeIdLike | BaseNode;
|
|
30
|
+
modellingRule?: ModellingRuleType;
|
|
31
|
+
references?: AddReferenceOpts[];
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
*/
|
|
35
|
+
accessRestrictions?: AccessRestrictionsFlag;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
*/
|
|
39
|
+
rolePermissions?: RolePermissionTypeOptions[];
|
|
40
|
+
}
|
|
41
|
+
export interface AddObjectTypeOptions extends AddBaseNodeOptions {
|
|
42
|
+
isAbstract?: boolean;
|
|
43
|
+
/**
|
|
44
|
+
* @default BaseObjectType
|
|
45
|
+
*/
|
|
46
|
+
subtypeOf?: string | UAObjectType;
|
|
47
|
+
eventNotifier?: number;
|
|
48
|
+
postInstantiateFunc?: (node: UAObject) => void;
|
|
49
|
+
}
|
|
50
|
+
export interface AddVariableTypeOptions extends AddBaseNodeOptions, VariableStuff {
|
|
51
|
+
isAbstract?: boolean;
|
|
52
|
+
/**
|
|
53
|
+
* @default BaseVariableType
|
|
54
|
+
*/
|
|
55
|
+
subtypeOf?: string | UAVariableType;
|
|
56
|
+
postInstantiateFunc?: (node: UAVariableType) => void;
|
|
57
|
+
value?: VariantLike;
|
|
58
|
+
}
|
|
59
|
+
export interface AddReferenceTypeOptions extends AddBaseNodeOptions {
|
|
60
|
+
isAbstract?: boolean;
|
|
61
|
+
inverseName: string;
|
|
62
|
+
subtypeOf?: string | NodeId | UAReferenceType;
|
|
63
|
+
}
|
|
64
|
+
export interface EnumerationItem {
|
|
65
|
+
description?: LocalizedTextLike;
|
|
66
|
+
displayName: LocalizedTextLike;
|
|
67
|
+
value: number;
|
|
68
|
+
}
|
|
69
|
+
export interface AddEnumerationTypeOptions extends AddBaseNodeOptions {
|
|
70
|
+
enumeration: string[] | EnumerationItem[];
|
|
71
|
+
}
|
|
72
|
+
export interface AddObjectOptions extends AddBaseNodeOptions {
|
|
73
|
+
eventNotifier?: number;
|
|
74
|
+
typeDefinition?: string | NodeId | UAObjectType;
|
|
75
|
+
nodeVersion?: string;
|
|
76
|
+
encodingOf?: NodeId | BaseNode;
|
|
77
|
+
}
|
|
78
|
+
export interface AddViewOptions extends AddBaseNodeOptions {
|
|
79
|
+
typeDefinition?: string | NodeId | UAObjectType;
|
|
80
|
+
}
|
|
81
|
+
export interface AddMethodOptions {
|
|
82
|
+
nodeId?: NodeIdLike;
|
|
83
|
+
browseName: QualifiedNameLike;
|
|
84
|
+
displayName?: LocalizedTextLike;
|
|
85
|
+
description?: LocalizedTextLike;
|
|
86
|
+
inputArguments?: ArgumentOptions[];
|
|
87
|
+
modellingRule?: ModellingRuleType;
|
|
88
|
+
outputArguments?: ArgumentOptions[];
|
|
89
|
+
componentOf?: NodeIdLike | BaseNode;
|
|
90
|
+
executable?: boolean;
|
|
91
|
+
userExecutable?: boolean;
|
|
92
|
+
accessRestrictions?: AccessRestrictionsFlag;
|
|
93
|
+
rolePermissions?: RolePermissionTypeOptions[];
|
|
94
|
+
}
|
|
95
|
+
export declare type AccessLevelString = string;
|
|
96
|
+
export interface VariableStuff {
|
|
97
|
+
dataType?: string | NodeIdLike | UADataType;
|
|
98
|
+
/**
|
|
99
|
+
* This Attribute indicates whether the Value Attribute of the Variable is an array and how many dimensions
|
|
100
|
+
* the array has.
|
|
101
|
+
* It may have the following values:
|
|
102
|
+
* n > 1: the Value is an array with the specified number of dimensions.
|
|
103
|
+
* OneDimension (1): The value is an array with one dimension.
|
|
104
|
+
* OneOrMoreDimensions (0): The value is an array with one or more dimensions.
|
|
105
|
+
* Scalar (?1): The value is not an array.
|
|
106
|
+
* Any (?2): The value can be a scalar or an array with any number of dimensions.
|
|
107
|
+
* ScalarOrOneDimension (?3): The value can be a scalar or a one dimensional array.
|
|
108
|
+
* NOTE All DataTypes are considered to be scalar, even if they have array-like semantics
|
|
109
|
+
* like ByteString and String.
|
|
110
|
+
*/
|
|
111
|
+
valueRank?: UInt32;
|
|
112
|
+
/**
|
|
113
|
+
* This Attribute specifies the length of each dimension for an array value. T
|
|
114
|
+
* The Attribute is intended to describe the capability of the Variable, not the current size.
|
|
115
|
+
* The number of elements shall be equal to the value of the ValueRank Attribute. Shall be null
|
|
116
|
+
* if ValueRank ? 0.
|
|
117
|
+
* A value of 0 for an individual dimension indicates that the dimension has a variable length.
|
|
118
|
+
* For example, if a Variable is defined by the following C array:
|
|
119
|
+
* Int32 myArray[346];
|
|
120
|
+
* then this Variables DataType would point to an Int32, the Variable�s ValueRank has the
|
|
121
|
+
* value 1 and the ArrayDimensions is an array with one entry having the value 346.
|
|
122
|
+
* Note that the maximum length of an array transferred on the wire is 2147483647 (max Int32)
|
|
123
|
+
* and a multi-dimensional array is encoded as a one dimensional array.
|
|
124
|
+
*/
|
|
125
|
+
arrayDimensions?: UInt32[] | null;
|
|
126
|
+
/**
|
|
127
|
+
* The AccessLevel Attribute is used to indicate how the Value of a Variable can be accessed
|
|
128
|
+
* (read/write) and if it contains current and/or historic data. The AccessLevel does not take
|
|
129
|
+
* any user access rights into account, i.e. although the Variable is writable this may be
|
|
130
|
+
* restricted to a certain user / user group.
|
|
131
|
+
*
|
|
132
|
+
* https://reference.opcfoundation.org/v104/Core/docs/Part3/8.57/
|
|
133
|
+
*/
|
|
134
|
+
accessLevel?: UInt32 | AccessLevelString;
|
|
135
|
+
/**
|
|
136
|
+
* The UserAccessLevel Attribute is used to indicate how the Value of a Variable can be accessed
|
|
137
|
+
* (read/write) and if it contains current or historic data taking user access rights into account.
|
|
138
|
+
* https://reference.opcfoundation.org/v104/Core/docs/Part3/8.57/
|
|
139
|
+
*/
|
|
140
|
+
userAccessLevel?: UInt32 | AccessLevelString;
|
|
141
|
+
/**
|
|
142
|
+
* The minimumSamplingInterval Attribute indicates how 'current' the Value of the Variable will
|
|
143
|
+
* be kept.
|
|
144
|
+
* It specifies (in milliseconds) how fast the Server can reasonably sample the value
|
|
145
|
+
* for changes (see Part 4 for a detailed description of sampling interval).
|
|
146
|
+
* A minimumSamplingInterval of 0 indicates that the Server is to monitor the item continuously.
|
|
147
|
+
* A minimumSamplingInterval of -1 means indeterminate.
|
|
148
|
+
*/
|
|
149
|
+
minimumSamplingInterval?: number;
|
|
150
|
+
/**
|
|
151
|
+
* The Historizing Attribute indicates whether the Server is actively collecting data for the
|
|
152
|
+
* history of the Variable.
|
|
153
|
+
* This differs from the AccessLevel Attribute which identifies if the
|
|
154
|
+
* Variable has any historical data. A value of TRUE indicates that the Server is actively
|
|
155
|
+
* collecting data. A value of FALSE indicates the Server is not actively collecting data.
|
|
156
|
+
* Default value is FALSE.
|
|
157
|
+
*/
|
|
158
|
+
historizing?: boolean;
|
|
159
|
+
dataValue?: DataValueOptions;
|
|
160
|
+
}
|
|
161
|
+
export interface AddVariableOptionsWithoutValue extends AddBaseNodeOptions, VariableStuff {
|
|
162
|
+
}
|
|
163
|
+
export interface AddVariableOptions extends AddVariableOptionsWithoutValue {
|
|
164
|
+
typeDefinition?: string | NodeId | UAVariableType;
|
|
165
|
+
value?: BindVariableOptions;
|
|
166
|
+
postInstantiateFunc?: (node: UAVariable) => void;
|
|
167
|
+
}
|
|
168
|
+
export interface CreateDataTypeOptions extends AddBaseNodeOptions {
|
|
169
|
+
isAbstract: boolean;
|
|
170
|
+
subtypeOf?: string | NodeId | UADataType;
|
|
171
|
+
partialDefinition?: StructureFieldOptions[] | EnumFieldOptions[];
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
*
|
|
175
|
+
* @param options.componentOf {NodeId}
|
|
176
|
+
* @param options.browseName {String}
|
|
177
|
+
* @param options.title {String}
|
|
178
|
+
* @param [options.instrumentRange]
|
|
179
|
+
* @param [options.instrumentRange.low] {Double}
|
|
180
|
+
* @param [options.instrumentRange.high] {Double}
|
|
181
|
+
* @param options.engineeringUnitsRange.low {Double}
|
|
182
|
+
* @param options.engineeringUnitsRange.high {Double}
|
|
183
|
+
* @param options.engineeringUnits {String}
|
|
184
|
+
* @param [options.nodeId = {NodeId}]
|
|
185
|
+
* @param options.accessLevel
|
|
186
|
+
* @param options.userAccessLevel
|
|
187
|
+
* @param options.title {String}
|
|
188
|
+
* @param options.axisScaleType {AxisScaleEnumeration}
|
|
189
|
+
*
|
|
190
|
+
* @param options.xAxisDefinition {AxisInformation}
|
|
191
|
+
* @param options.xAxisDefinition.engineeringUnits EURange
|
|
192
|
+
* @param options.xAxisDefinition.range
|
|
193
|
+
* @param options.xAxisDefinition.range.low
|
|
194
|
+
* @param options.xAxisDefinition.range.high
|
|
195
|
+
* @param options.xAxisDefinition.title {LocalizedText}
|
|
196
|
+
* @param options.xAxisDefinition.axisScaleType {AxisScaleEnumeration}
|
|
197
|
+
* @param options.xAxisDefinition.axisSteps = <null> {Array<Double>}
|
|
198
|
+
* @param options.value
|
|
199
|
+
*/
|
|
200
|
+
export interface AddYArrayItemOptions extends AddVariableOptions {
|
|
201
|
+
title: string;
|
|
202
|
+
instrumentRange?: RangeOptions;
|
|
203
|
+
engineeringUnitsRange?: RangeOptions;
|
|
204
|
+
engineeringUnits?: EUInformationOptions;
|
|
205
|
+
axisScaleType: AxisScaleEnumeration | string;
|
|
206
|
+
xAxisDefinition?: AxisInformationOptions;
|
|
207
|
+
}
|
|
208
|
+
export declare type CreateNodeOptions = any;
|
|
209
|
+
export declare interface INamespace {
|
|
210
|
+
version: string;
|
|
211
|
+
publicationDate: Date;
|
|
212
|
+
namespaceUri: string;
|
|
213
|
+
addressSpace: IAddressSpace;
|
|
214
|
+
index: number;
|
|
215
|
+
constructNodeId(options: ConstructNodeIdOptions): NodeId;
|
|
216
|
+
findObjectType(objectType: string): UAObjectType | null;
|
|
217
|
+
findVariableType(variableType: string): UAVariableType | null;
|
|
218
|
+
findDataType(dataType: string): UADataType | null;
|
|
219
|
+
findReferenceType(referenceType: string): UAReferenceType | null;
|
|
220
|
+
findReferenceTypeFromInverseName(referenceType: string): UAReferenceType | null;
|
|
221
|
+
findNode(nodeId: NodeIdLike): BaseNode | null;
|
|
222
|
+
findNode2(nodeId: NodeId): BaseNode | null;
|
|
223
|
+
addAlias(aliasName: string, nodeId: NodeId): void;
|
|
224
|
+
addObjectType(options: AddObjectTypeOptions): UAObjectType;
|
|
225
|
+
addVariableType(options: AddVariableTypeOptions): UAVariableType;
|
|
226
|
+
addReferenceType(options: AddReferenceTypeOptions): UAReferenceType;
|
|
227
|
+
addEnumerationType(options: AddEnumerationTypeOptions): UADataType;
|
|
228
|
+
createDataType(options: CreateDataTypeOptions): UADataType;
|
|
229
|
+
addVariable(options: AddVariableOptions): UAVariable;
|
|
230
|
+
addObject(options: AddObjectOptions): UAObject;
|
|
231
|
+
addView(options: AddViewOptions): UAView;
|
|
232
|
+
addFolder(parentFolder: NodeIdLike | UAObject, options: any): UAObject;
|
|
233
|
+
createNode(options: CreateNodeOptions): BaseNode;
|
|
234
|
+
internalCreateNode(options: CreateNodeOptions): BaseNode;
|
|
235
|
+
deleteNode(node: NodeId | BaseNode): void;
|
|
236
|
+
/**
|
|
237
|
+
* add a new event type to the address space
|
|
238
|
+
* @example
|
|
239
|
+
*
|
|
240
|
+
* const evtType = namespace.addEventType({
|
|
241
|
+
* browseName: "MyAuditEventType",
|
|
242
|
+
* subtypeOf: "AuditEventType"
|
|
243
|
+
* });
|
|
244
|
+
* const myConditionType = namespace.addEventType({
|
|
245
|
+
* browseName: "MyConditionType",
|
|
246
|
+
* subtypeOf: "ConditionType",
|
|
247
|
+
* isAbstract: false
|
|
248
|
+
* });
|
|
249
|
+
*
|
|
250
|
+
*/
|
|
251
|
+
addEventType(options: {
|
|
252
|
+
browseName: QualifiedNameLike;
|
|
253
|
+
/**
|
|
254
|
+
* @default BaseEventType
|
|
255
|
+
*/
|
|
256
|
+
subtypeOf?: string | UAEventType;
|
|
257
|
+
isAbstract?: boolean;
|
|
258
|
+
}): UAEventType;
|
|
259
|
+
/**
|
|
260
|
+
*
|
|
261
|
+
*/
|
|
262
|
+
addMethod(parent: UAObject | UAObjectType, options: AddMethodOptions): UAMethod;
|
|
263
|
+
toNodeset2XML(): string;
|
|
264
|
+
/**
|
|
265
|
+
* @internals
|
|
266
|
+
*/
|
|
267
|
+
getStandardsNodeIds(): {
|
|
268
|
+
referenceTypeIds: {
|
|
269
|
+
[key: string]: string;
|
|
270
|
+
};
|
|
271
|
+
objectTypeIds: {
|
|
272
|
+
[key: string]: string;
|
|
273
|
+
};
|
|
274
|
+
};
|
|
275
|
+
setDefaultRolePermissions(rolePermissions: RolePermissionTypeOptions[] | null): void;
|
|
276
|
+
getDefaultRolePermissions(): RolePermissionType[] | null;
|
|
277
|
+
setDefaultAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void;
|
|
278
|
+
getDefaultAccessRestrictions(): AccessRestrictionsFlag;
|
|
279
|
+
}
|
package/dist/namespace.js
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
//# sourceMappingURL=namespace.js.map
|