Package com.plccom.opc.ua.client.utils

Class UaEventFilterUtils

java.lang.Object

com.plccom.opc.ua.client.utils.UaEventFilterUtils

public class UaEventFilterUtils
extends Object

PLCcom sdk UaEventFilterUtils Implementation with necessary static event mechanisms

Author:

Indi.An GmbH, www.indi-an.com, support@indi-an.com

Constructor Summary

Constructors

Constructor	Description
UaEventFilterUtils()

Method Summary

Modifier and Type	Method	Description
static void	addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter, com.plccom.opc.ua.builtintypes.NodeId eventTypeId, com.plccom.opc.ua.builtintypes.QualifiedName propertyName)	Adds the specified property to the event filter.
static void	addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter, com.plccom.opc.ua.builtintypes.NodeId eventTypeId, com.plccom.opc.ua.builtintypes.QualifiedName propertyName, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId)	Adds the specified property to the event filter.
static void	addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter, com.plccom.opc.ua.builtintypes.NodeId eventTypeId, com.plccom.opc.ua.builtintypes.QualifiedName propertyName, UaAttributes attribute)	Adds the specified property to the event filter.
static void	addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter, com.plccom.opc.ua.builtintypes.NodeId eventTypeId, BrowseNames propertyName)	Adds the specified property to the event filter.
static void	addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter, com.plccom.opc.ua.builtintypes.NodeId eventTypeId, BrowseNames propertyName, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId)	Adds the specified property to the event filter.
static void	addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter, com.plccom.opc.ua.builtintypes.NodeId eventTypeId, BrowseNames propertyName, UaAttributes attribute)	Adds the specified property to the event filter.
static void	addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter, com.plccom.opc.ua.builtintypes.NodeId eventTypeId, String browsePath, com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId)	Adds the specified browse path to the event filter.
static void	addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter, com.plccom.opc.ua.core.SimpleAttributeOperand simpleAttributeOperand)	Adds the specified property to the event filter.
static ArrayList<com.plccom.opc.ua.core.SimpleAttributeOperand>	constructSelectClauses(UaClient client, com.plccom.opc.ua.builtintypes.NodeId... eventTypeIds)	contsructs one ore more select clauses for the given eventTypeIds *
static com.plccom.opc.ua.core.EventFilter	createEventfilter(boolean setDefaultInstanceNode)	Standard constructor for UaEventFilter instances
static com.plccom.opc.ua.core.EventFilter	createEventfilter(com.plccom.opc.ua.core.SimpleAttributeOperand[] SelectClauses, com.plccom.opc.ua.core.ContentFilter WhereClause)	constructor for UaEventFilter instances with given select and where clauses
static com.plccom.opc.ua.core.EventFilter	createFilter(UaClient client, com.plccom.opc.ua.builtintypes.NodeId... eventTypeIds)	Construct the eventfilter for the given eventTypeIds

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UaEventFilterUtils

public UaEventFilterUtils()

Method Detail

createEventfilter

public static com.plccom.opc.ua.core.EventFilter createEventfilter(boolean setDefaultInstanceNode)

Standard constructor for UaEventFilter instances

Parameters:

setDefaultInstanceNode - if parameter is true, automatically setting the the default instance node = Identifiers.BaseEventType The default instance node must always request the NodeId for the condition instances. this can be done by specifying an operand with an empty browse path.

Returns:

the created event filter object

createEventfilter

public static com.plccom.opc.ua.core.EventFilter createEventfilter(com.plccom.opc.ua.core.SimpleAttributeOperand[] SelectClauses,
                                                                   com.plccom.opc.ua.core.ContentFilter WhereClause)

constructor for UaEventFilter instances with given select and where clauses

Parameters:

SelectClauses - an array of select clauses

WhereClause - a content filter object with given filter rules

Returns:

the created event filter object

addSelectClause

public static void addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter,
                                   com.plccom.opc.ua.builtintypes.NodeId eventTypeId,
                                   BrowseNames propertyName)

Adds the specified property to the event filter.

Parameters:

eventFilter - the EventFilter object

eventTypeId - event type id as NodeId object

propertyName - name of property @see BrowseNames

addSelectClause

public static void addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter,
                                   com.plccom.opc.ua.builtintypes.NodeId eventTypeId,
                                   BrowseNames propertyName,
                                   UaAttributes attribute)

Adds the specified property to the event filter.

Parameters:

eventFilter - the EventFilter object

eventTypeId - event type id as NodeId object

propertyName - name of property @see BrowseNames

attribute - the attribute

addSelectClause

public static void addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter,
                                   com.plccom.opc.ua.builtintypes.NodeId eventTypeId,
                                   BrowseNames propertyName,
                                   com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId)

Adds the specified property to the event filter.

Parameters:

eventFilter - the EventFilter object

eventTypeId - event type id as NodeId object

propertyName - name of property @see BrowseNames

attributeId - the attribute

addSelectClause

public static void addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter,
                                   com.plccom.opc.ua.builtintypes.NodeId eventTypeId,
                                   com.plccom.opc.ua.builtintypes.QualifiedName propertyName)

Adds the specified property to the event filter.

Parameters:

eventFilter - the EventFilter object

eventTypeId - event type id as NodeId object

propertyName - name of property @see BrowseNames

addSelectClause

public static void addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter,
                                   com.plccom.opc.ua.builtintypes.NodeId eventTypeId,
                                   com.plccom.opc.ua.builtintypes.QualifiedName propertyName,
                                   UaAttributes attribute)

Adds the specified property to the event filter.

Parameters:

eventFilter - the EventFilter object

eventTypeId - event type id as NodeId object

propertyName - name of property @see BrowseNames

attribute - the attribute

addSelectClause

public static void addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter,
                                   com.plccom.opc.ua.builtintypes.NodeId eventTypeId,
                                   com.plccom.opc.ua.builtintypes.QualifiedName propertyName,
                                   com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId)

Adds the specified property to the event filter.

Parameters:

eventFilter - the EventFilter object

eventTypeId - event type id as NodeId object

propertyName - name of property @see BrowseNames

attributeId - the attribute

addSelectClause

public static void addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter,
                                   com.plccom.opc.ua.core.SimpleAttributeOperand simpleAttributeOperand)

Adds the specified property to the event filter.

Parameters:

eventFilter - the EventFilter object

simpleAttributeOperand - a simpleAttributeOperand object

addSelectClause

public static void addSelectClause(com.plccom.opc.ua.core.EventFilter eventFilter,
                                   com.plccom.opc.ua.builtintypes.NodeId eventTypeId,
                                   String browsePath,
                                   com.plccom.opc.ua.builtintypes.UnsignedInteger attributeId)

Adds the specified browse path to the event filter.

Parameters:

eventFilter - the EventFilter object

eventTypeId - event type id as NodeId object

browsePath - browse path of event type id as NodeId object

attributeId - the atribute

createFilter

public static com.plccom.opc.ua.core.EventFilter createFilter(UaClient client,
                                                              com.plccom.opc.ua.builtintypes.NodeId... eventTypeIds)
                                                       throws com.plccom.opc.ua.common.ServiceResultException

Construct the eventfilter for the given eventTypeIds

Parameters:

client - a valid UaClient object

eventTypeIds - one or more 'event type ids' as NodeId

Returns:

a EventFilter object with select and where clauses

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error

constructSelectClauses

public static ArrayList<com.plccom.opc.ua.core.SimpleAttributeOperand> constructSelectClauses(UaClient client,
                                                                                              com.plccom.opc.ua.builtintypes.NodeId... eventTypeIds)
                                                                                       throws com.plccom.opc.ua.common.ServiceResultException

contsructs one ore more select clauses for the given eventTypeIds *

Note: 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.

Parameters:

client - a valid UaClient object

eventTypeIds - one or more 'event type ids' as NodeId

Returns:

a Arraylist of SimpleAttributeOperand objects as select clauses

Throws:

com.plccom.opc.ua.common.ServiceResultException - on communication error