Options
All
  • Public
  • Public/Protected
  • All
Menu

  subscribe now with sterfive to access the online-user manual

HasEffect ReferenceType

The HasEffect ReferenceType is a concrete ReferenceType and can be used directly. It is a subtype of NonHierarchicalReferences. The semantic of this ReferenceType is to point form a Transition to something that will be effected when the Transition is triggered. In this annex we only define EventTypes as Effects.

However, the ReferenceType is not restricted to point to EventTypes.

The SourceNode of this ReferenceType shall be an Object of the ObjectType TransitionType or one of its subtypes. The TargetNode can be of any NodeClass.

Hierarchy

Index

Properties

Readonly browseName

browseName: QualifiedName

Readonly inverseName

inverseName: LocalizedText

Readonly isAbstract

isAbstract: boolean

Readonly nodeClass

nodeClass: ReferenceType

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>

Readonly subtypeOf

subtypeOf: NodeId

Readonly subtypeOfObj

subtypeOfObj: UAReferenceType

Accessors

accessRestrictions

addressSpace

  • Returns IAddressSpace

description

  • Returns LocalizedText

displayName

  • Returns LocalizedText[]

modellingRule

  • Returns ModellingRuleType

namespace

  • Returns INamespace

namespaceIndex

  • get namespaceIndex(): number
  • Returns number

namespaceUri

  • get namespaceUri(): string
  • Returns string

parentNodeId

  • Returns NodeId

rolePermissions

  • Returns RolePermissionType[]

Methods

addReference

allReferences

browseNode

browseNodeByTargetName

checkHasSubtype

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

    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

    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

    Returns BaseNode[]

findReferencesEx

  • 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

    Returns UAReference[]

findReferencesExAsObject

  • 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

    Returns 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

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

getAllSubtypes

getChildByName

getDisplayName

  • getDisplayName(locale?: string): string
  • Parameters

    • Optional locale: string

      the locale of the text to return (e.g. en-EN)

    Returns string

getEventSourceOfs

getEventSources

getRolePermissions

install_extra_properties

  • install_extra_properties(): void

isSupertypeOf

readAttribute

removeReference

setAccessRestrictions

setRolePermissions

writeAttribute

Generated using TypeDoc