UADataSetFolder | NodeOPCUA reference documentation

Hierarchy

UAFolder
UADataSetFolder_Base
- UADataSetFolder

Index

Properties

Accessors

Methods

Properties

Optional addDataSetFolder

addDataSetFolder: UAMethod

Optional addPublishedDataItems

addPublishedDataItems: UAMethod

Optional addPublishedDataItemsTemplate

addPublishedDataItemsTemplate: UAMethod

Optional addPublishedEvents

addPublishedEvents: UAMethod

Optional addPublishedEventsTemplate

addPublishedEventsTemplate: UAMethod

Readonly browseName

browseName: QualifiedName

Readonly eventNotifier

eventNotifier: number

Readonly hasMethods

hasMethods: boolean

Readonly nodeClass

nodeClass: Object

Readonly nodeId

nodeId: NodeId

Optional nodeVersion

nodeVersion: UAVariableT<string, String>

NodeVersion (Optional) String The NodeVersion Property is used to indicate the version of a Node. The NodeVersion Property is updated each time a Reference is added or deleted to the Node the Property belongs to. Attribute value changes do not cause the NodeVersion to change. Clients may read the NodeVersion Property or subscribe to it to determine when the structure of a Node has changed.

Optional onFirstBrowseAction

onFirstBrowseAction: () => Promise<void>

Type declaration

- (): Promise<void>
- Returns Promise<void>

Optional removeDataSetFolder

removeDataSetFolder: UAMethod

Optional removePublishedDataSet

removePublishedDataSet: UAMethod

Accessors

accessRestrictions

get accessRestrictions(): AccessRestrictionsFlag

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:64
Returns AccessRestrictionsFlag

addressSpace

get addressSpace(): IAddressSpace

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:56
Returns IAddressSpace

description

get description(): LocalizedText

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:59
Returns LocalizedText

displayName

get displayName(): LocalizedText[]

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:58
Returns LocalizedText[]

modellingRule

get modellingRule(): ModellingRuleType

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:62
Returns ModellingRuleType

namespace

get namespace(): INamespace

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:68
Returns INamespace

namespaceIndex

get namespaceIndex(): number

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:66
Returns number

namespaceUri

get namespaceUri(): string

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:67
Returns string

parent

get parent(): BaseNode

- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:110
Returns BaseNode

parentNodeId

get parentNodeId(): NodeId

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:63
Returns NodeId

rolePermissions

get rolePermissions(): RolePermissionType[]

- Defined in node-opcua-address-space-base/dist/base_node.d.ts:65
Returns RolePermissionType[]

typeDefinition

get typeDefinition(): NodeId

- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:112
Returns NodeId

typeDefinitionObj

get typeDefinitionObj(): UAObjectType

- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:111
Returns UAObjectType

Methods

addReference

addReference(options: AddReferenceOpts): void

Inherited from UAFolder.addReference
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:75
Parameters
- options: AddReferenceOpts
Returns void

allReferences

allReferences(): UAReference[]

Inherited from UAFolder.allReferences
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:142
Returns UAReference[]

browseNode

browseNode(browseDescription: BrowseDescriptionOptions2, session?: ISessionContext): ReferenceDescription[]

Inherited from UAFolder.browseNode
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:155
browse the node to extract information requested in browseDescription

Parameters
- browseDescription: BrowseDescriptionOptions2
- Optional session: ISessionContext
Returns ReferenceDescription[]

browseNodeByTargetName

browseNodeByTargetName(relativePathElement: RelativePathElement, isLast: boolean): NodeId[]

Inherited from UAFolder.browseNodeByTargetName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:98
Parameters
- relativePathElement: RelativePathElement
- isLast: boolean
Returns NodeId[]

clone

clone(options: CloneOptions, optionalFilter?: CloneFilter, extraInfo?: CloneExtraInfo): UAObject

Inherited from UAFolder.clone
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:123
Parameters
- options: CloneOptions
- Optional optionalFilter: CloneFilter
- Optional extraInfo: CloneExtraInfo
Returns UAObject

findReference

findReference(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference

Inherited from UAFolder.findReference
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:123
find the the references that are strictly of type reference.

The isForward boolean flag specifies the direction of the references to be looked for.

Forward direction is implied if omitted.
- will throw an exception if more than one reference exists with the referenceType.
- will return null if no reference exists.
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns UAReference

findReferences

findReferences(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): UAReference[]

Inherited from UAFolder.findReferences
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:112
find all the references that are strictly of type reference. The isForward boolean flag specifies the direction of the references to be looked for.

Forward direction is implied if omitted.

Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns UAReference[]

findReferencesAsObject

findReferencesAsObject(referenceType: string | NodeId | UAReferenceType, isForward?: boolean): BaseNode[]

Inherited from UAFolder.findReferencesAsObject
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:141
find all the nodes that are referenced by references strictly of type reference.

The isForward boolean flag specifies the direction of the references to be looked for.

Forward direction is implied if omitted.
- will throw an exception if more than one reference exists with the referenceType.
- will return null if no reference exists.
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional isForward: boolean
Returns BaseNode[]

findReferencesEx

findReferencesEx(referenceType: string | NodeId | UAReferenceType, browseDirection?: BrowseDirection): UAReference[]

Inherited from UAFolder.findReferencesEx
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:105
find all the references that are of type reference or a sub type of reference, in the direction specified by browseDirection
- BrowseDirection.Forward direction is implied if browseDirection flags is omitted.
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional browseDirection: BrowseDirection
Returns UAReference[]

findReferencesExAsObject

findReferencesExAsObject(referenceType: string | NodeId | UAReferenceType, browseDirection?: BrowseDirection): BaseNode[]

Inherited from UAFolder.findReferencesExAsObject
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:130
find all the nodes that are referenced by references of type reference or a sub type of reference, in the direction specified by browseDirection
- BrowseDirection.Forward direction is implied if browseDirection flags is omitted.
Parameters
- referenceType: string | NodeId | UAReferenceType
- Optional browseDirection: BrowseDirection
Returns BaseNode[]

fullName

fullName(): string

Inherited from UAFolder.fullName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:74
return a complete name of this object by pre-pending name of its parent(s) to its own name

Returns string

getAccessRestrictions

getAccessRestrictions(inherited: boolean): AccessRestrictionsFlag

Inherited from UAFolder.getAccessRestrictions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:174
get effective accessRestrictions if (inherited is true) and node has no accessRestrictions, then default accessRestriction from namespace is returned if (inherited is false) and node has no accessRestrictions, then AccessRestrictionsFlag.None is returned

Parameters
- inherited: boolean
Returns AccessRestrictionsFlag

getAggregates

getAggregates(): BaseNode[]

Inherited from UAFolder.getAggregates
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:185
Returns BaseNode[]

getChildByName

getChildByName(browseName: QualifiedNameOptions): BaseNode
getChildByName(browseName: string, namespaceIndex?: number): BaseNode

Inherited from UAFolder.getChildByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:143
Parameters
- browseName: QualifiedNameOptions
Returns BaseNode
Inherited from UAFolder.getChildByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:144
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode

getComponentByName

getComponentByName(componentName: QualifiedNameOptions): UAObject | UAVariable
getComponentByName(componentName: string, namespaceIndex?: number): UAObject | UAVariable

Inherited from UAFolder.getComponentByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:39
Parameters
- componentName: QualifiedNameOptions
Returns UAObject | UAVariable
Inherited from UAFolder.getComponentByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:40
Parameters
- componentName: string
- Optional namespaceIndex: number
Returns UAObject | UAVariable

getComponents

getComponents(): BaseNode[]

Inherited from UAFolder.getComponents
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:44
Returns BaseNode[]

getDisplayName

getDisplayName(locale?: string): string

Inherited from UAFolder.getDisplayName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:93
Parameters
- Optional locale: string
  
  the locale of the text to return (e.g. en-EN)
Returns string

getEventSourceOfs

getEventSourceOfs(): BaseNode[]

Inherited from UAFolder.getEventSourceOfs
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:88
return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

Returns BaseNode[]

getEventSources

getEventSources(): BaseNode[]

Inherited from UAFolder.getEventSources
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:83
return a array with the event source of this object. self = HasEventSource => nodes

Returns BaseNode[]

getFolderElementByName

getFolderElementByName(browseName: QualifiedNameOptions): BaseNode
getFolderElementByName(browseName: string, namespaceIndex?: number): BaseNode

Inherited from UAFolder.getFolderElementByName
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:115
Parameters
- browseName: QualifiedNameOptions
Returns BaseNode
Inherited from UAFolder.getFolderElementByName
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:116
Parameters
- browseName: string
- Optional namespaceIndex: number
Returns BaseNode

getMethodById

getMethodById(nodeId: NodeId): UAMethod

Inherited from UAFolder.getMethodById
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:117
Parameters
- nodeId: NodeId
Returns UAMethod

getMethodByName

getMethodByName(methodName: QualifiedNameOptions): UAMethod
getMethodByName(methodName: string, namespaceIndex?: number): UAMethod

Inherited from UAFolder.getMethodByName
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:118
Parameters
- methodName: QualifiedNameOptions
Returns UAMethod
Inherited from UAFolder.getMethodByName
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:119
Parameters
- methodName: string
- Optional namespaceIndex: number
Returns UAMethod

getMethods

getMethods(): UAMethod[]

Inherited from UAFolder.getMethods
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:120
Returns UAMethod[]

getNotifiers

getNotifiers(): BaseNode[]

Inherited from UAFolder.getNotifiers
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:46
Returns BaseNode[]

getProperties

getProperties(): BaseNode[]

Inherited from UAFolder.getProperties
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:45
Returns BaseNode[]

getPropertyByName

getPropertyByName(propertyName: QualifiedNameOptions): UAVariable
getPropertyByName(propertyName: string, namespaceIndex?: number): UAVariable

Inherited from UAFolder.getPropertyByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:41
Parameters
- propertyName: QualifiedNameOptions
Returns UAVariable
Inherited from UAFolder.getPropertyByName
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:42
Parameters
- propertyName: string
- Optional namespaceIndex: number
Returns UAVariable

getRolePermissions

getRolePermissions(inherited: boolean): RolePermissionType[]

Inherited from UAFolder.getRolePermissions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:161
Parameters
- inherited: boolean
Returns RolePermissionType[]

install_extra_properties

install_extra_properties(): void

Inherited from UAFolder.install_extra_properties
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:97
private

Returns void

on

on(eventName: "event", eventHandler: (eventData: IEventData) => void): UADataSetFolder

Inherited from UAFolder.on
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:122
Parameters
- eventName: "event"
- eventHandler: (eventData: IEventData) => void
  - - (eventData: IEventData): void
    - Parameters
      - eventData: IEventData
      Returns void
Returns UADataSetFolder

raiseEvent

raiseEvent(eventType: BaseNode | EventTypeLike, eventData: RaiseEventData): void

Inherited from UAFolder.raiseEvent
- Defined in node-opcua-address-space-base/dist/ua_object.d.ts:121
Parameters
- eventType: BaseNode | EventTypeLike
- eventData: RaiseEventData
Returns void

readAttribute

readAttribute(context: ISessionContext, attributeId: AttributeIds, indexRange?: NumericRange, dataEncoding?: QualifiedNameLike): DataValue

Inherited from UAFolder.readAttribute
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:77
Parameters
- context: ISessionContext
- attributeId: AttributeIds
- Optional indexRange: NumericRange
- Optional dataEncoding: QualifiedNameLike
Returns DataValue

removeReference

removeReference(referenceOpts: AddReferenceOpts): void

Inherited from UAFolder.removeReference
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:76
Parameters
- referenceOpts: AddReferenceOpts
Returns void

setAccessRestrictions

setAccessRestrictions(accessRestrictions: AccessRestrictionsFlag): void

Inherited from UAFolder.setAccessRestrictions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:165
setAccessRestriction

Parameters
- accessRestrictions: AccessRestrictionsFlag
Returns void

setRolePermissions

setRolePermissions(rolePermissions: RolePermissionTypeOptions[]): void

Inherited from UAFolder.setRolePermissions
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:160
Parameters
- rolePermissions: RolePermissionTypeOptions[]
Returns void

writeAttribute

writeAttribute(context: ISessionContext, writeValue: WriteValueOptions, callback: (err: Error, statusCode?: StatusCode) => void): void

Inherited from UAFolder.writeAttribute
- Defined in node-opcua-address-space-base/dist/base_node.d.ts:78
Parameters
- context: ISessionContext
- writeValue: WriteValueOptions
- callback: (err: Error, statusCode?: StatusCode) => void
  - - (err: Error, statusCode?: StatusCode): void
    - Parameters
      - err: Error
      - Optional statusCode: StatusCode
      Returns void
Returns void

subscribe now with sterfive to access the online-user manual

Hierarchy

Index

Properties

Accessors

Methods

Properties

Optional addDataSetFolder

Optional addPublishedDataItems

Optional addPublishedDataItemsTemplate

Optional addPublishedEvents

Optional addPublishedEventsTemplate

Readonly browseName

Readonly eventNotifier

Readonly hasMethods

Readonly nodeClass

Readonly nodeId

Optional nodeVersion

Optional onFirstBrowseAction

Type declaration

Returns Promise<void>

Optional removeDataSetFolder

Optional removePublishedDataSet

Accessors

accessRestrictions

Returns AccessRestrictionsFlag

addressSpace

Returns IAddressSpace

description

Returns LocalizedText

displayName

Returns LocalizedText[]

modellingRule

Returns ModellingRuleType

namespace

Returns INamespace

namespaceIndex

Returns number

namespaceUri

Returns string

parent

Returns BaseNode

parentNodeId

Returns NodeId

rolePermissions

Returns RolePermissionType[]

typeDefinition

Returns NodeId

typeDefinitionObj

Returns UAObjectType

Methods

addReference

Parameters

options: AddReferenceOpts

Returns void

allReferences

Returns UAReference[]

browseNode

Parameters

browseDescription: BrowseDescriptionOptions2

Optional session: ISessionContext

Returns ReferenceDescription[]

browseNodeByTargetName

Parameters

relativePathElement: RelativePathElement

isLast: boolean

Returns NodeId[]

clone

Parameters

options: CloneOptions

Optional optionalFilter: CloneFilter

Optional extraInfo: CloneExtraInfo

Returns UAObject

findReference

Parameters

referenceType: string | NodeId | UAReferenceType

Optional isForward: boolean

Returns UAReference

findReferences

Parameters