Interface InstantiateOffNormalAlarmOptions

interface InstantiateOffNormalAlarmOptions {
    browseName: QualifiedNameLike;
    componentOf?: NodeIdLike | BaseNode;
    conditionClass?:
        | null
        | NodeId
        | BaseNode
        | UAObject;
    conditionName?: string;
    conditionOf?:
        | null
        | NodeId
        | BaseNode
        | UAObject;
    conditionSource?: null | NodeId | BaseNode;
    copyAlsoModellingRules?: boolean;
    description?: LocalizedTextLike;
    displayName?: null | LocalizedTextLike;
    encodingOf?: NodeId | BaseNode;
    eventNotifier?: EventNotifierFlags;
    eventSourceOf?: NodeIdLike | BaseNode;
    inputNode: NodeId | BaseNode;
    maxTimeShelved?: number;
    modellingRule?: ModellingRuleType;
    namespace?: INamespace;
    nodeId?: NodeIdLike;
    normalState?: null | NodeIdLike | UAVariable;
    notifierOf?: NodeIdLike | BaseNode;
    optionals?: string[];
    organizedBy?: NodeIdLike | BaseNode;
}

Hierarchy (view full)

Properties

browseName componentOf? conditionClass? conditionName? conditionOf? conditionSource? copyAlsoModellingRules? description? displayName? encodingOf? eventNotifier? eventSourceOf? inputNode maxTimeShelved? modellingRule? namespace? nodeId? normalState? notifierOf? optionals? organizedBy?

Properties

browseName

browseName: QualifiedNameLike

the browse name of the new node to instantiate

OptionalcomponentOf

componentOf?: NodeIdLike | BaseNode

the parent Object holding this object note

  • when componentOf is specified, organizedBy must not be defined

OptionalconditionClass

conditionClass?:
    | null
    | NodeId
    | BaseNode
    | UAObject

OptionalconditionName

conditionName?: string

OptionalconditionOf

conditionOf?:
    | null
    | NodeId
    | BaseNode
    | UAObject

OptionalconditionSource

conditionSource?: null | NodeId | BaseNode

OptionalcopyAlsoModellingRules

copyAlsoModellingRules?: boolean

shall we also replicate the HasModelling rule reference ?

Optionaldescription

description?: LocalizedTextLike

an optional description

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

OptionaldisplayName

displayName?: null | LocalizedTextLike

an optional displayName

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

OptionalencodingOf

encodingOf?: NodeId | BaseNode

OptionaleventNotifier

eventNotifier?: EventNotifierFlags

OptionaleventSourceOf

eventSourceOf?: NodeIdLike | BaseNode

inputNode

inputNode: NodeId | BaseNode

OptionalmaxTimeShelved

maxTimeShelved?: number

OptionalmodellingRule

modellingRule?: ModellingRuleType

modellingRule

Optionalnamespace

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)

OptionalnodeId

nodeId?: NodeIdLike

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

OptionalnormalState

normalState?: null | NodeIdLike | UAVariable

https://reference.opcfoundation.org/v105/Core/docs/Part9/5.8.23/#5.8.23.2

The NormalState Property is a Property that points to a Variable which has a value that corresponds to one of the possible values of the Variable pointed to by the InputNode Property where the NormalState Property Variable value is the value that is considered to be the normal state of the Variable pointed to by the InputNode Property.

When the value of the Variable referenced by the InputNode Property is not equal to the value of the NormalState Property the Alarm is Active. If this Variable is not in the AddressSpace, a NULL NodeId shall be provided.

OptionalnotifierOf

notifierOf?: NodeIdLike | BaseNode

Optionaloptionals

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

Example

  optionals: ["MyOptionalVariable", "MyOptionalMethod", "MyOptionalComponent.MyProperty"];

@default: []

OptionalorganizedBy

organizedBy?: NodeIdLike | BaseNode

the parent Folder holding this object

note

  • when organizedBy is specified, componentOf must not be defined

Settings

Member Visibility

On This Page

Properties