C# Class Quickstarts.FilterDefinition

Defines a event filter for a subscription.

Show file Open project: OPCFoundation/UA-.NET

Public Properties

Property	Type	Description
AreaId	Opc.Ua.NodeId
EventTypes	IList
SelectClauses	SimpleAttributeOperandCollection
Severity	EventSeverity

Public Methods

Method	Description
ConstructFilter ( Session session ) : EventFilter	Constructs the event filter for the subscription.
ConstructSelectClauses ( Session session ) : SimpleAttributeOperandCollection	Constructs the select clauses for a set of event types. Each event type is an ObjectType in the address space. The fields supported by the server are defined as children of the ObjectType. Many of the fields are manadatory and are defined by the UA information model, however, indiviudual servers many not support all of the optional fields. This method browses the type model and
CreateMonitoredItem ( Session session ) : MonitoredItem	Creates the monitored item based on the current definition.

Private Methods

Method	Description
CollectFields ( Session session, Opc.Ua.NodeId nodeId, QualifiedNameCollection parentPath, SimpleAttributeOperandCollection eventFields, QualifiedNameCollection>.Dictionary foundNodes ) : void	Collects the fields for the instance node.
CollectFields ( Session session, Opc.Ua.NodeId eventTypeId, SimpleAttributeOperandCollection eventFields ) : void	Collects the fields for the event type.
ContainsPath ( SimpleAttributeOperandCollection selectClause, QualifiedNameCollection browsePath ) : bool	Determines whether the specified select clause contains the browse path.

Method Details

ConstructFilter() public method

Constructs the event filter for the subscription.

public ConstructFilter ( Session session ) : EventFilter
session	Opc.Ua.Client.Session
return	Opc.Ua.EventFilter

ConstructSelectClauses() public method

Constructs the select clauses for a set of event types.

Each event type is an ObjectType in the address space. The fields supported by the server are defined as children of the ObjectType. Many of the fields are manadatory and are defined by the UA information model, however, indiviudual servers many not support all of the optional fields. This method browses the type model and

public ConstructSelectClauses ( Session session ) : SimpleAttributeOperandCollection
session	Opc.Ua.Client.Session	The session.
return	SimpleAttributeOperandCollection

CreateMonitoredItem() public method

Creates the monitored item based on the current definition.

public CreateMonitoredItem ( Session session ) : MonitoredItem
session	Opc.Ua.Client.Session	The session.
return	Opc.Ua.Client.MonitoredItem

Property Details

AreaId public property

The NodeId for the Area that is subscribed to (the entire Server if not specified).

public NodeId,Opc.Ua AreaId
return	Opc.Ua.NodeId

EventTypes public property

The types for the events of interest.

public IList EventTypes
return	IList

SelectClauses public property

The select clauses to use with the filter.

public SimpleAttributeOperandCollection SelectClauses
return	SimpleAttributeOperandCollection

Severity public property

The minimum severity for the events of interest.

public EventSeverity Severity
return	EventSeverity