Hierarchy
- UAAlarmCondition
-
UADiscrepancyAlarm_Base
- UADiscrepancyAlarm
Index
Properties
- access
Restrictions - acked
State - acknowledge
- active
State - add
Comment - address
Space - audible
Enabled - audible
Sound - branch
Id - browse
Name - client
User Id - comment
- condition
Class Id - condition
Class Name - condition
Name - condition
Refresh - condition
Refresh2 - condition
Sub Class Id - condition
Sub Class Name - confirm
- confirmed
State - description
- disable
- display
Name - enable
- enabled
State - event
Id - event
Notifier - event
Type - expected
Time - first
InGroup - first
InGroup Flag - has
Methods - input
Node - last
Severity - latched
State - local
Time - max
Time Shelved - message
- modelling
Rule - namespace
- namespace
Index - namespace
Uri - node
Class - node
Id - node
Version - off
Delay - on
Delay - on
First Browse Action - out
OfService State - parent
- parent
Node Id - place
InService - quality
- re
Alarm Repeat Count - re
Alarm Time - receive
Time - remove
From Service - reset
- retain
- role
Permissions - severity
- shelving
State - silence
- silence
State - source
Name - source
Node - suppress
- suppressed
OrShelved - suppressed
State - target
Value Node - time
- tolerance
- type
Definition - type
Definition Obj - unsuppress
Methods
- add
Reference - all
References - browse
Node - browse
Node ByTarget Name - clone
- 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
Folder Element ByName - get
Method ById - get
Method ByName - get
Methods - get
Notifiers - get
Properties - get
Property ByName - get
Role Permissions - install_
extra_ properties - on
- raise
Event - read
Attribute - remove
Reference - set
Access Restrictions - set
Role Permissions - write
Attribute
Properties
accessRestrictions
ackedState
acknowledge
activeState
addComment
addressSpace
Optional audibleEnabled
Optional audibleSound
branchId
Readonly browseName
clientUserId
comment
conditionClassId
conditionClassName
conditionName
conditionRefresh
conditionRefresh2
Optional conditionSubClassId
Optional conditionSubClassName
Optional confirm
Optional confirmedState
description
disable
displayName
enable
enabledState
eventId
Readonly eventNotifier
eventType
expectedTime
Optional firstInGroup
Optional firstInGroupFlag
Readonly hasMethods
inputNode
lastSeverity
Optional latchedState
Optional localTime
Optional maxTimeShelved
message
modellingRule
namespace
namespaceIndex
namespaceUri
Readonly nodeClass
Readonly nodeId
Optional nodeVersion
Optional offDelay
Optional onDelay
Optional onFirstBrowseAction
Type declaration
-
-
Returns Promise<void>
-
Optional outOfServiceState
parent
parentNodeId
Optional placeInService
quality
Optional reAlarmRepeatCount
Optional reAlarmTime
receiveTime
Optional removeFromService
Optional reset
retain
rolePermissions
severity
Optional shelvingState
Optional silence
Optional silenceState
sourceName
sourceNode
Optional suppress
suppressedOrShelved
Optional suppressedState
targetValueNode
time
Optional tolerance
typeDefinition
typeDefinitionObj
Optional unsuppress
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[]
-
clone
-
Parameters
-
options: CloneOptions
-
Optional optionalFilter: CloneFilter
-
Optional extraInfo: CloneExtraInfo
Returns UAObject
-
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[]
getFolderElementByName
-
Parameters
-
browseName: QualifiedNameOptions
Returns BaseNode
-
-
Parameters
-
browseName: string
-
Optional namespaceIndex: number
Returns BaseNode
-
getMethodById
getMethodByName
-
Parameters
-
methodName: QualifiedNameOptions
Returns UAMethod
-
-
Parameters
-
methodName: string
-
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
on
-
Parameters
-
eventName: "event"
-
eventHandler: (eventData: IEventData) => void
-
-
Parameters
-
eventData: IEventData
Returns void
-
-
-
Returns UACondition
-
raiseEvent
-
Parameters
-
eventType: BaseNode | EventTypeLike
-
eventData: RaiseEventData
Returns void
-
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
-
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.