.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaClient.ItemEventFilter Class Reference

A filter for an Event monitored item. More...

Inherits ICloneable.

Public Member Functions

 ItemEventFilter ()
 Initializes a new instance of the EventFilter class. More...
 
 ItemEventFilter (StringTable namespaceUris)
 Initializes a new instance of the EventFilter class. More...
 
void SetDefault ()
 Sets the default filter. More...
 
GetValue< T > (EventFieldList e, QualifiedName browseName, T defaultValue)
 Gets the field value. More...
 
GetValue< T > (EventFieldList e, ExpandedNodeId typeId, QualifiedName browseName, T defaultValue)
 Gets the field value. More...
 
GetValue< T > (EventFieldList e, QualifiedName[] browsePath, T defaultValue)
 Gets the value. More...
 
GetValue< T > (EventFieldList e, ExpandedNodeId typeId, QualifiedName[] browsePath, T defaultValue)
 Gets the value. More...
 
GetValue< T > (HistoryEventFieldList e, QualifiedName browseName, T defaultValue)
 Gets the field value. More...
 
GetValue< T > (HistoryEventFieldList e, ExpandedNodeId typeId, QualifiedName browseName, T defaultValue)
 Gets the field value. More...
 
GetValue< T > (HistoryEventFieldList e, QualifiedName[] browsePath, T defaultValue)
 Gets the value. More...
 
GetValue< T > (HistoryEventFieldList e, ExpandedNodeId typeId, QualifiedName[] browsePath, T defaultValue)
 Gets the value. More...
 
EventFilter ToEventFilter ()
 Returns an event filter that can be used in a call to the server. More...
 
object Clone ()
 Creates a new object that is a copy of the current instance. More...
 
void SaveAll (IEncoder encoder)
 Saves the EventFilter using the specified encoder. More...
 
void LoadAll (IDecoder decoder)
 Initializes the EventFilter using the specified decoder. More...
 

Static Public Member Functions

static string ToString (Session session, ContentFilterElement element)
 Returns a System.String that represents this instance. More...
 
static string ToString (Session session, ContentFilterElement element, int index)
 Returns a System.String that represents this instance. More...
 

Properties

SelectClauseCollection SelectClauses [get]
 Gets or sets the select clauses. More...
 
WhereClauseCollection WhereClauses [get]
 Gets or sets the where clauses. More...
 

Detailed Description

A filter for an Event monitored item.

Constructor & Destructor Documentation

UnifiedAutomation.UaClient.ItemEventFilter.ItemEventFilter ( )

Initializes a new instance of the EventFilter class.

UnifiedAutomation.UaClient.ItemEventFilter.ItemEventFilter ( StringTable  namespaceUris)

Initializes a new instance of the EventFilter class.

Parameters
namespaceUrisThe namespace uris.

Member Function Documentation

object UnifiedAutomation.UaClient.ItemEventFilter.Clone ( )

Creates a new object that is a copy of the current instance.

Returns
A new object that is a copy of this instance.
T UnifiedAutomation.UaClient.ItemEventFilter.GetValue< T > ( EventFieldList  e,
QualifiedName  browseName,
defaultValue 
)

Gets the field value.

Template Parameters
T
Parameters
eThe e.
browseNameName of the browse.
defaultValueThe default value.
Returns
T UnifiedAutomation.UaClient.ItemEventFilter.GetValue< T > ( EventFieldList  e,
ExpandedNodeId  typeId,
QualifiedName  browseName,
defaultValue 
)

Gets the field value.

Template Parameters
T
Parameters
eThe e.
typeIdThe type id.
browseNameName of the browse.
defaultValueThe default value.
Returns
T UnifiedAutomation.UaClient.ItemEventFilter.GetValue< T > ( EventFieldList  e,
QualifiedName[]  browsePath,
defaultValue 
)

Gets the value.

Template Parameters
T
Parameters
eThe e.
browsePathThe browse path.
defaultValueThe default value.
Returns
T UnifiedAutomation.UaClient.ItemEventFilter.GetValue< T > ( EventFieldList  e,
ExpandedNodeId  typeId,
QualifiedName[]  browsePath,
defaultValue 
)

Gets the value.

Template Parameters
T
Parameters
eThe e.
typeIdThe type id.
browsePathThe browse path.
defaultValueThe default value.
Returns
T UnifiedAutomation.UaClient.ItemEventFilter.GetValue< T > ( HistoryEventFieldList  e,
QualifiedName  browseName,
defaultValue 
)

Gets the field value.

Template Parameters
T
Parameters
eThe e.
browseNameName of the browse.
defaultValueThe default value.
Returns
T UnifiedAutomation.UaClient.ItemEventFilter.GetValue< T > ( HistoryEventFieldList  e,
ExpandedNodeId  typeId,
QualifiedName  browseName,
defaultValue 
)

Gets the field value.

Template Parameters
T
Parameters
eThe e.
typeIdThe type id.
browseNameName of the browse.
defaultValueThe default value.
Returns
T UnifiedAutomation.UaClient.ItemEventFilter.GetValue< T > ( HistoryEventFieldList  e,
QualifiedName[]  browsePath,
defaultValue 
)

Gets the value.

Template Parameters
T
Parameters
eThe e.
browsePathThe browse path.
defaultValueThe default value.
Returns
T UnifiedAutomation.UaClient.ItemEventFilter.GetValue< T > ( HistoryEventFieldList  e,
ExpandedNodeId  typeId,
QualifiedName[]  browsePath,
defaultValue 
)

Gets the value.

Template Parameters
T
Parameters
eThe e.
typeIdThe type id.
browsePathThe browse path.
defaultValueThe default value.
Returns
void UnifiedAutomation.UaClient.ItemEventFilter.LoadAll ( IDecoder  decoder)

Initializes the EventFilter using the specified decoder.

Parameters
decoderThe decoder to load the EventFilter.
void UnifiedAutomation.UaClient.ItemEventFilter.SaveAll ( IEncoder  encoder)

Saves the EventFilter using the specified encoder.

Parameters
encoderThe encoder to save the EventFilter.
void UnifiedAutomation.UaClient.ItemEventFilter.SetDefault ( )

Sets the default filter.

EventFilter UnifiedAutomation.UaClient.ItemEventFilter.ToEventFilter ( )

Returns an event filter that can be used in a call to the server.

static string UnifiedAutomation.UaClient.ItemEventFilter.ToString ( Session  session,
ContentFilterElement  element 
)
static

Returns a System.String that represents this instance.

Parameters
sessionThe session.
elementThe element.
Returns
A System.String that represents this instance.
static string UnifiedAutomation.UaClient.ItemEventFilter.ToString ( Session  session,
ContentFilterElement  element,
int  index 
)
static

Returns a System.String that represents this instance.

Parameters
sessionThe session.
elementThe element.
indexThe index.
Returns
A System.String that represents this instance.

Property Documentation

SelectClauseCollection UnifiedAutomation.UaClient.ItemEventFilter.SelectClauses
get

Gets or sets the select clauses.

The select clauses.

WhereClauseCollection UnifiedAutomation.UaClient.ItemEventFilter.WhereClauses
get

Gets or sets the where clauses.

The where clauses.


The documentation for this class was generated from the following file: