Hierarchy
-
NonHierarchicalReferences
- HasSubStateMachine
Index
Properties
Accessors
Methods
- add
Reference - all
References - browse
Node - browse
Node ByTarget Name - check
Has Subtype - find
Reference - find
References - find
References AsObject - find
References Ex - find
References ExAs Object - full
Name - get
Access Restrictions - get
Aggregates - get
All Subtypes - get
Child ByName - get
Display Name - get
Event Source Ofs - get
Event Sources - get
Role Permissions - install_
extra_ properties - is
Supertype Of - read
Attribute - remove
Reference - set
Access Restrictions - set
Role Permissions - write
Attribute
Properties
Readonly browseName
Readonly inverseName
Readonly isAbstract
Readonly nodeClass
Readonly nodeId
Optional nodeVersion
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
Type declaration
-
-
Returns Promise<void>
-
Readonly subtypeOf
Readonly subtypeOfObj
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
parentNodeId
-
Returns NodeId
rolePermissions
-
Returns RolePermissionType[]
Methods
addReference
-
Parameters
-
options: AddReferenceOpts
Returns void
-
allReferences
-
Returns UAReference[]
browseNode
-
browse the node to extract information requested in browseDescription
Parameters
-
browseDescription: BrowseDescriptionOptions2
-
Optional session: ISessionContext
Returns ReferenceDescription[]
-
browseNodeByTargetName
-
Parameters
-
relativePathElement: RelativePathElement
-
isLast: boolean
Returns NodeId[]
-
checkHasSubtype
-
Parameters
-
referenceType: NodeId | UAReference
Returns boolean
-
findReference
-
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
-
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
-
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
-
find all the references that are of type
referenceor a sub type ofreference, in the direction specified bybrowseDirection- BrowseDirection.Forward direction is implied if browseDirection flags is omitted.
Parameters
-
referenceType: string | NodeId | UAReferenceType
-
Optional browseDirection: BrowseDirection
Returns UAReference[]
findReferencesExAsObject
-
find all the nodes that are referenced by references of type
referenceor a sub type ofreference, in the direction specified bybrowseDirection- BrowseDirection.Forward direction is implied if browseDirection flags is omitted.
Parameters
-
referenceType: string | NodeId | UAReferenceType
-
Optional browseDirection: BrowseDirection
Returns BaseNode[]
fullName
-
return a complete name of this object by pre-pending name of its parent(s) to its own name
Returns string
getAccessRestrictions
-
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
-
Returns BaseNode[]
getAllSubtypes
-
Returns UAReferenceType[]
getChildByName
-
Parameters
-
browseName: QualifiedNameOptions
Returns BaseNode
-
-
Parameters
-
browseName: string
-
Optional namespaceIndex: number
Returns BaseNode
-
getDisplayName
-
Parameters
-
Optional locale: string
the locale of the text to return (e.g. en-EN)
Returns string
-
getEventSourceOfs
-
return a array of the objects for which this node is an EventSource nodes = HasEventSource => self
Returns BaseNode[]
getEventSources
-
return a array with the event source of this object. self = HasEventSource => nodes
Returns BaseNode[]
getRolePermissions
-
Parameters
-
inherited: boolean
Returns RolePermissionType[]
-
install_extra_properties
-
private
Returns void
isSupertypeOf
-
Parameters
-
baseType: NodeIdLike | UAReferenceType
Returns boolean
-
readAttribute
-
Parameters
-
context: ISessionContext
-
attributeId: AttributeIds
-
Optional indexRange: NumericRange
-
Optional dataEncoding: QualifiedNameLike
Returns DataValue
-
removeReference
-
Parameters
-
referenceOpts: AddReferenceOpts
Returns void
-
setAccessRestrictions
-
setAccessRestriction
Parameters
-
accessRestrictions: AccessRestrictionsFlag
Returns void
-
setRolePermissions
-
Parameters
-
rolePermissions: RolePermissionTypeOptions[]
Returns void
-
writeAttribute
-
Parameters
-
context: ISessionContext
-
writeValue: WriteValueOptions
-
callback: (err: Error, statusCode?: StatusCode) => void
-
-
Parameters
-
err: Error
-
Optional statusCode: StatusCode
Returns void
-
-
-
Returns void
-
The HasSubStateMachine ReferenceType is a concrete ReferenceType and can be used directly. It is a subtype of NonHierarchicalReferences.
The semantic of this ReferenceType is to point from a State to an instance of StateMachineType which represents the sub-states for the State.
The SourceNode of this ReferenceType shall be an Object of the ObjectType StateType.
The TargetNode shall be an Object of the ObjectType StateMachineType or one of its subtypes.
Each Object can be the TargetNode of at most one HasSubStateMachine Reference.
The SourceNode (the state) and the TargetNode (the SubStateMachine) shall belong to the same StateMachine, that is, both shall be referenced from the same Object of type StateMachineType using a HasComponent Reference or a subtype of HasComponent.