Hierarchy
- UAInitialState_Base
-
UAStateType
- UAInitialStateType
Index
Properties
Accessors
Methods
- add
Reference - all
References - browse
Node - browse
Node ByTarget Name - find
Reference - find
References - find
References AsObject - find
References Ex - find
References ExAs Object - full
Name - get
Access Restrictions - get
Aggregates - get
Child ByName - get
Component ByName - get
Components - get
Display Name - get
Event Source Ofs - get
Event Sources - get
Method ById - get
Method ByName - get
Methods - get
Notifiers - get
Properties - get
Property ByName - get
Role Permissions - install_
extra_ properties - instantiate
- is
Supertype Of - read
Attribute - remove
Reference - set
Access Restrictions - set
Role Permissions - write
Attribute
Properties
Readonly browseName
Readonly hasMethods
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>
-
stateNumber
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[]
-
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[]
getChildByName
-
Parameters
-
browseName: QualifiedNameOptions
Returns BaseNode
-
-
Parameters
-
browseName: string
-
Optional namespaceIndex: number
Returns BaseNode
-
getComponentByName
-
Parameters
-
componentName: QualifiedNameOptions
Returns UAObject | UAVariable
-
-
Parameters
-
componentName: string
-
Optional namespaceIndex: number
Returns UAObject | UAVariable
-
getComponents
-
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[]
getMethodById
getMethodByName
-
Parameters
-
methodName: QualifiedNameOptions
Returns UAMethod
-
-
Parameters
-
methodName: string
-
Optional namespaceIndex: number
Returns UAMethod
-
-
Parameters
-
methodName: QualifiedNameLike
-
Optional namespaceIndex: number
Returns UAMethod
-
getMethods
-
Returns UAMethod[]
getNotifiers
-
Returns BaseNode[]
getProperties
-
Returns BaseNode[]
getPropertyByName
-
Parameters
-
propertyName: QualifiedNameOptions
Returns UAVariable
-
-
Parameters
-
propertyName: string
-
Optional namespaceIndex: number
Returns UAVariable
-
getRolePermissions
-
Parameters
-
inherited: boolean
Returns RolePermissionType[]
-
install_extra_properties
-
private
Returns void
instantiate
-
Parameters
-
options: InstantiateObjectOptions
Returns UAObject
-
isSupertypeOf
-
Parameters
-
referenceType: NodeIdLike | UAObjectType
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
-
Initial State Type
The InitialStateType is a subtype of the StateType and is formally defined in Table B.8. An Object of the InitialStateType represents the State that a FiniteStateMachine enters when it is activated.
Each FiniteStateMachine can have at most one State of type InitialStateType, but a FiniteStateMachine does not have to have a State of this type.
A SubStateMachine goes into its initial state whenever the parent state is entered. However, a state machine may define a transition that goes directly to a state of the SubStateMachine. In this case the SubStateMachine goes into that State instead of the initial State. The two scenarios are illustrated in Figure B.4. The transition from State5 to State6 causes the SubStateMachine to go into the initial State (State7), however, the transition from State4 to State8 causes the parent machine to go to State6 and the SubStateMachine will go to State8.
If no initial state for a SubStateMachine exists and the State having the SubStateMachine is entered directly, then the State of the SubStateMachine is server-specific.