Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UAConditionBase

Hierarchy

Implements

  • UAObject
  • UAObject
  • UAObject
  • UAObject
  • UAObject
  • UAObject

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

addComment

addComment: UAMethod

Readonly addressSpace

addressSpace: AddressSpace

branchId

branchId: UAVariableT<NodeId, NodeId>

Readonly browseName

browseName: QualifiedName

comment

comment: UAConditionVariable<LocalizedText, LocalizedText>

conditionClassId

conditionClassId: UAVariableT<NodeId, NodeId>

conditionClassName

conditionClassName: UAVariableT<LocalizedText, LocalizedText>

conditionName

conditionName: UAVariableT<string, String>

Readonly description

description: LocalizedText

disable

disable: UAMethod

Readonly displayName

displayName: LocalizedText[]

enable

enable: UAMethod

enabledState

enabledState: UATwoStateVariable

eventId

eventId: UAVariable

Readonly eventNotifier

eventNotifier: number

eventType

eventType: UAVariableT<NodeId, NodeId>

Readonly isAbstract

isAbstract: boolean

lastSeverity

lastSeverity: UAConditionVariable<StatusCode, StatusCode>

localTime

localTime: UAVariableT<any, ExtensionObject>

message

message: UAVariableT<LocalizedText, LocalizedText>

Optional Readonly modellingRule

modellingRule: ModellingRuleType

Readonly namespace

namespace: Namespace

Readonly namespaceIndex

namespaceIndex: number

Readonly namespaceUri

namespaceUri: string

Readonly nodeClass

nodeClass: Object = 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: function

Type declaration

    • (this: BaseNode): Promise<void>
    • Parameters

      • this: BaseNode

      Returns Promise<void>

Optional Readonly parentNodeId

parentNodeId: NodeId

quality

quality: UAConditionVariable<StatusCode, StatusCode>

receiveTime

receiveTime: UAVariableT<Date, DateTime>

retain

retain: UAVariableT<boolean, Boolean>

severity

severity: UAVariableT<UInt16, UInt16>

sourceName

sourceName: UAVariableT<string, String>

sourceNode

sourceNode: UAVariableT<NodeId, NodeId>

Readonly subtypeOf

subtypeOf: NodeId | null

Readonly subtypeOfObj

subtypeOfObj: UAObjectType | null

Readonly symbolicName

symbolicName: string

time

time: UAVariableT<DateTime, DateTime>

Static defaultSeverity

defaultSeverity: number = 250

Static typeDefinition

typeDefinition: NodeId = resolveNodeId("ConditionType")

Accessors

hasMethods

  • get hasMethods(): boolean

typeDefinitionObj

  • get typeDefinitionObj(): UAObjectTypePublic

Methods

_assert_valid

  • _assert_valid(): void
  • Returns void

_bubble_up_event

  • _bubble_up_event(eventData: any): void

_conditionRefresh

  • _conditionRefresh(_cache?: any): void

_resend_conditionEvents

  • _resend_conditionEvents(): 1 | 0
  • Returns 1 | 0

addListener

  • addListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

addReference

allReferences

browseNode

  • browseNode(browseDescription: BrowseDescriptionOptions, session?: SessionContext): ReferenceDescription[]
  • browse the node to extract information requested in browseDescription

    method

    browseNode

    Parameters

    • browseDescription: BrowseDescriptionOptions
    • Optional session: SessionContext

    Returns ReferenceDescription[]

clone

  • clone(options: any, optionalFilter?: any, extraInfo?: any): UAObject

conditionOfNode

  • conditionOfNode(): UAObject | UAVariable | null
  • conditionOfNode(): UAVariable | UAObject | null
  • method

    conditionOfNode

    Returns UAObject | UAVariable | null

  • Returns UAVariable | UAObject | null

createBranch

  • method

    createBranch

    Returns ConditionSnapshot

  • Returns ConditionSnapshot

currentBranch

  • method

    currentBranch

    Returns ConditionSnapshot

  • Returns ConditionSnapshot

deleteBranch

  • method

    deleteBranch

    Parameters

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>
  • Returns Array<string | symbol>

findReference

  • findReference(strReference: string, isForward?: boolean): UAReference | null
  • Parameters

    • strReference: string
    • Optional isForward: boolean

    Returns UAReference | null

findReferences

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

    • referenceType: string | NodeId | UAReferenceType
    • Optional isForward: boolean

    Returns UAReference[]

findReferencesAsObject

  • findReferencesAsObject(strReference: string, isForward: boolean): BaseNode[]
  • Parameters

    • strReference: string
    • isForward: boolean

    Returns BaseNode[]

findReferencesEx

findReferencesExAsObject

  • findReferencesExAsObject(strReference: string, browseDirection?: BrowseDirection): BaseNode[]

fullName

  • fullName(): string
  • return a complete name of this object by pre-pending name of its parent(s) to its own name

    Returns string

getAggregates

  • getAggregates(): BaseNode[]
  • Returns BaseNode[]

getBranchCount

  • getBranchCount(): number
  • getBranchCount(): number
  • Returns number

  • Returns number

getBranchId

  • getBranchId(): NodeId[]
  • Returns NodeId[]

getBranchIds

  • getBranchIds(): NodeId[]
  • Returns NodeId[]

getBranches

  • Returns ConditionSnapshot[]

  • Returns ConditionSnapshot[]

getChildByName

  • getChildByName(browseName: string | QualifiedName): BaseNode | null
  • Parameters

    • browseName: string | QualifiedName

    Returns BaseNode | null

getComponentByName

  • getComponentByName(componentName: QualifiedNameLike, namespaceIndex?: number): UAObject | UAVariable | null

getComponents

  • getComponents(): BaseNode[]
  • Returns BaseNode[]

getEnabledState

  • getEnabledState(): boolean
  • getEnabledState(): boolean
  • method

    getEnabledState

    Returns boolean

  • Returns boolean

getEnabledStateAsString

  • getEnabledStateAsString(): string
  • getEnabledStateAsString(): string
  • method

    getEnabledStateAsString

    Returns string

  • Returns string

getEventSourceOfs

  • getEventSourceOfs(): BaseNode[]
  • return a array of the objects for which this node is an EventSource nodes = HasEventSource => self

    Returns BaseNode[]

getEventSources

  • getEventSources(): BaseNode[]
  • return a array with the event source of this object. self = HasEventSource => nodes

    Returns BaseNode[]

getMaxListeners

  • getMaxListeners(): number

getMethodById

  • getMethodById(nodeId: NodeId): UAMethod | null
  • Parameters

    • nodeId: NodeId

    Returns UAMethod | null

getMethodByName

  • getMethodByName(methodName: string): UAMethodPublic | null

getMethods

  • getMethods(): UAMethodPublic[]

getNotifiers

  • getNotifiers(): BaseNode[]
  • Returns BaseNode[]

getProperties

  • getProperties(): BaseNode[]
  • Returns BaseNode[]

getPropertyByName

  • getPropertyByName(browseName: string, namespaceIndex?: number): UAVariable | null
  • Parameters

    • browseName: string
    • Optional namespaceIndex: number

    Returns UAVariable | null

install_extra_properties

  • install_extra_properties(): void

instantiate

isSupertypeOf

  • isSupertypeOf(referenceType: NodeIdLike | UAObjectType): boolean
  • Parameters

    Returns boolean

listenerCount

  • listenerCount(event: string | symbol): number
  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(eventName: string, eventHandler: function): this
  • on(eventName: "addComment", eventHandler: function): this
  • on(eventName: "branch_deleted", eventHandler: function): this
  • Parameters

    • eventName: string
    • eventHandler: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

  • Parameters

    • eventName: "addComment"
    • eventHandler: function
        • Parameters

          Returns void

    Returns this

  • Parameters

    • eventName: "branch_deleted"
    • eventHandler: function
        • (branchId: string): void
        • Parameters

          • branchId: string

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

propagate_back_references

  • propagate_back_references(): void
  • this methods propagates the forward references to the pointed node by inserting backward references to the counter part node

    Returns void

raiseConditionEvent

  • method

    raiseConditionEvent Raise a Instance Event (see also UAObject#raiseEvent to raise a transient event)

    Parameters

    • branch: ConditionSnapshot

      the condition branch to raise

    • renewEventId: boolean

      true if event Id of the condition branch should be renewed

    Returns void

  • Parameters

    Returns void

raiseEvent

raiseNewBranchState

  • Parameters

    Returns void

  • Parameters

    Returns void

raiseNewCondition

  • method

    raiseNewCondition

    Parameters

    Returns void

  • Parameters

    Returns void

rawListeners

  • rawListeners(event: string | symbol): Function[]
  • Parameters

    • event: string | symbol

    Returns Function[]

readAttribute

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeListener

  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

removeReference

setEnableState

  • setEnableState(state: boolean): StatusCode
  • Parameters

    • state: boolean

    Returns StatusCode

setLocalTime

  • setLocalTime(time: TimeZoneDataType): void
  • method

    setLocalTime (optional)

    Parameters

    • time: TimeZoneDataType

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this

setReceiveTime

  • setReceiveTime(time: Date): void
  • method

    setReceiveTime

    Parameters

    Returns void

setSourceName

  • setSourceName(name: string): void

setSourceNode

  • setSourceNode(node: NodeId | BaseNode): void

setTime

  • setTime(time: Date): void
  • setTime(time: Date): void
  • method

    setTime

    Parameters

    Returns void

  • Parameters

    Returns void

toString

  • toString(): string

writeAttribute

  • writeAttribute(context: SessionContext, writeValue: any, callback: function): void
  • Parameters

    • context: SessionContext
    • writeValue: any
    • callback: function
        • (err: Error | null, statusCode?: StatusCode): void
        • Parameters

          • err: Error | null
          • Optional statusCode: StatusCode

          Returns void

    Returns void

Static install_condition_refresh_handle

  • Parameters

    Returns void

Static instantiate

  • Parameters

    Returns UAConditionBase

Static with_condition_method

  • with_condition_method(inputArguments: VariantLike[], context: SessionContext, callback: function, inner_func: function): void
  • Helper method to handle condition methods that takes a branchId and a comment

    Parameters

    Returns void

Generated using TypeDoc