NodeOPCUA API Documentation
    Preparing search index...

    Interface InstantiateLimitAlarmOptions

    interface InstantiateLimitAlarmOptions {
        addInOf?: NodeId | BaseNode<BaseNodeEvents>;
        browseName: QualifiedNameLike;
        componentOf?: NodeIdLike | BaseNode<BaseNodeEvents>;
        conditionClass?:
            | NodeId
            | BaseNode<BaseNodeEvents>
            | UAObject<UAObjectEvents>
            | null;
        conditionName?: string;
        conditionOf?:
            | NodeId
            | BaseNode<BaseNodeEvents>
            | UAObject<UAObjectEvents>
            | null;
        conditionSource?: NodeId | BaseNode<BaseNodeEvents> | null;
        copyAlsoAllOptionals?: boolean;
        copyAlsoModellingRules?: boolean;
        description?: LocalizedTextLike;
        displayName?: LocalizedTextLike | null;
        encodingOf?: NodeId | BaseNode<BaseNodeEvents>;
        eventNotifier?: EventNotifierFlags;
        eventSourceOf?: NodeIdLike | BaseNode<BaseNodeEvents>;
        highHighLimit?: number;
        highLimit: number;
        inputNode: NodeId | UAVariable<UAVariableEvents>;
        lowLimit: number;
        lowLowLimit?: number;
        maxTimeShelved?: number;
        modellingRule?: ModellingRuleType;
        namespace?: INamespace;
        nodeId?: NodeIdLike;
        notifierOf?: NodeIdLike | BaseNode<BaseNodeEvents>;
        optionals?: string[];
        organizedBy?: NodeIdLike | BaseNode<BaseNodeEvents>;
        parentNodeId?: NodeIdLike | BaseNode<BaseNodeEvents>;
        references?: AddReferenceOpts[];
    }

    Hierarchy (View Summary)

    Index
    addInOf? browseName componentOf? conditionClass? conditionName? conditionOf? conditionSource? copyAlsoAllOptionals? copyAlsoModellingRules? description? displayName? encodingOf? eventNotifier? eventSourceOf? highHighLimit? highLimit inputNode lowLimit lowLowLimit? maxTimeShelved? modellingRule? namespace? nodeId? notifierOf? optionals? organizedBy? parentNodeId? references?
    addInOf?: NodeId | BaseNode<BaseNodeEvents>

    note

    • when addInOf is specified, organizedBy nor componentOf must not be defined
    browseName: QualifiedNameLike

    the browse name of the new node to instantiate

    componentOf?: NodeIdLike | BaseNode<BaseNodeEvents>

    the parent Object holding this object note

    • when componentOf is specified, organizedBy nor addInOf must not be defined
    conditionClass?:
        | NodeId
        | BaseNode<BaseNodeEvents>
        | UAObject<UAObjectEvents>
        | null
    conditionName?: string
    conditionOf?:
        | NodeId
        | BaseNode<BaseNodeEvents>
        | UAObject<UAObjectEvents>
        | null
    conditionSource?: NodeId | BaseNode<BaseNodeEvents> | null
    copyAlsoAllOptionals?: boolean
    copyAlsoModellingRules?: boolean

    shall we also replicate the HasModelling rule reference ?

    description?: LocalizedTextLike

    an optional description

    if not provided the default description of the corresponding Type will be used.

    displayName?: LocalizedTextLike | null

    an optional displayName

    if not provided the default description of the corresponding browseName will be used.

    encodingOf?: NodeId | BaseNode<BaseNodeEvents>
    eventNotifier?: EventNotifierFlags
    eventSourceOf?: NodeIdLike | BaseNode<BaseNodeEvents>
    highHighLimit?: number
    highLimit: number
    inputNode: NodeId | UAVariable<UAVariableEvents>
    lowLimit: number
    lowLowLimit?: number
    maxTimeShelved?: number
    modellingRule?: ModellingRuleType

    modellingRule

    namespace?: INamespace

    the namespace in which the node shall be instantiated (if not specified, the default instance namespace (own namespace) of the addressSpace will be used)

    nodeId?: NodeIdLike

    a (optional) predefined nodeId to assigned to the instance If not specified, a default nodeid will be created.

    notifierOf?: NodeIdLike | BaseNode<BaseNodeEvents>
    optionals?: string[]

    a list of components and properties names that have a HasModellingRule of Optional in the type definition that we want to instantiate. Note:

    • the name must follow the OPCUA naming convention and match the browse name of the property (same case)
    • the name can be composed to represent a path to a property or component
      optionals: ["MyOptionalVariable", "MyOptionalMethod", "MyOptionalComponent.MyProperty"];

    @default: []

    organizedBy?: NodeIdLike | BaseNode<BaseNodeEvents>

    the parent Folder holding this object

    note

    • when organizedBy is specified, componentOf nor addInOf must not be defined
    parentNodeId?: NodeIdLike | BaseNode<BaseNodeEvents>

    the declared parent, as ParentNodeId in a NodeSet: the instance's parent and what its symbolic name is built from, even when the only reference between the two is Organizes (a folder a type organizes is <Type>_<Folder> in the ModelCompiler's NodeIds.csv). See AddBaseNodeOptions.parentNodeId.

    references?: AddReferenceOpts[]

    additional references to create on the new node at construction time.

    Use it to link the instance to a parent through an aggregate reference that has no dedicated option (HasOrderedComponent, HasPhysicalComponent, HasContainedComponent, HasAttachedComponent ...):

      references: [{ referenceType: "HasOrderedComponent", isForward: false, nodeId: listNode }]

    Because the reference exists when the node is created, the NodeIdManager derives the symbolic name from that parent (List_First), exactly as it does for componentOf; adding the reference afterwards would leave the node named without its parent. Such a parent also counts when deciding whether modelling rules are copied (an instance declared inside a type).

    Settings
    Member Visibility

    On This Page
    Properties