C# Class Opc.Ua.Client.MonitoredItem

Inheritance: ICloneable
ファイルを表示 Open project: OPCFoundation/UA-.NET Class Usage Examples

Private Properties

Property Type Description
Initialize void
Initialize void
UseDefaultEventFilter void
ValidateFilter void

Public Methods

Method Description
Clone ( ) : object

Creates a deep copy of the object.

DequeueEvents ( ) : IList

Read all events in the cache queue.

DequeueValues ( ) : IList

Read all values in the cache queue.

GetEventTime ( EventFieldList eventFields ) : System.DateTime

Returns value of the field name containing the event type.

GetEventType ( EventFieldList eventFields ) : INode

Returns value of the field name containing the event type.

GetFieldName ( int index ) : string

Returns the field name the specified SelectClause in the EventFilter.

GetFieldValue ( EventFieldList eventFields, NodeId eventTypeId, IList browsePath, uint attributeId ) : object

Returns value of the field name containing the event type.

GetFieldValue ( EventFieldList eventFields, NodeId eventTypeId, QualifiedName browseName ) : object

Returns value of the field name containing the event type.

GetFieldValue ( EventFieldList eventFields, NodeId eventTypeId, string browsePath, uint attributeId ) : object

Returns value of the field name containing the event type.

GetServiceResult ( IEncodeable notification ) : ServiceResult

The service result for a data change notification.

GetServiceResult ( IEncodeable notification, int index ) : ServiceResult

The service result for a field in an notification (the field must contain a Status object).

MonitoredItem ( ) : System

Initializes a new instance of the MonitoredItem class.

MonitoredItem ( MonitoredItem template ) : System

Initializes a new instance of the MonitoredItem class.

MonitoredItem ( MonitoredItem template, bool copyEventHandlers ) : System

Initializes a new instance of the MonitoredItem class.

MonitoredItem ( uint clientHandle ) : System

Initializes a new instance of the MonitoredItem class.

SaveValueInCache ( IEncodeable newValue ) : void

Saves a data change or event in the cache.

SetCreateResult ( MonitoredItemCreateRequest request, MonitoredItemCreateResult result, int index, DiagnosticInfoCollection diagnosticInfos, ResponseHeader responseHeader ) : void

Updates the object with the results of a create monitored item request.

SetDeleteResult ( StatusCode result, int index, DiagnosticInfoCollection diagnosticInfos, ResponseHeader responseHeader ) : void

Updates the object with the results of a modify monitored item request.

SetError ( ServiceResult error ) : void

Sets the error status for the monitored item.

SetModifyResult ( MonitoredItemModifyRequest request, MonitoredItemModifyResult result, int index, DiagnosticInfoCollection diagnosticInfos, ResponseHeader responseHeader ) : void

Updates the object with the results of a modify monitored item request.

SetResolvePathResult ( BrowsePathResult result, int index, DiagnosticInfoCollection diagnosticInfos, ResponseHeader responseHeader ) : void

Updates the object with the results of a translate browse path request.

Private Methods

Method Description
Initialize ( ) : void

Sets the private members to default values.

Initialize ( StreamingContext context ) : void
UseDefaultEventFilter ( ) : void

Sets the default event filter.

ValidateFilter ( NodeClass nodeClass, MonitoringFilter filter ) : void

Throws an exception if the flter cannot be used with the node class.

Method Details

Clone() public method

Creates a deep copy of the object.
public Clone ( ) : object
return object

DequeueEvents() public method

Read all events in the cache queue.
public DequeueEvents ( ) : IList
return IList

DequeueValues() public method

Read all values in the cache queue.
public DequeueValues ( ) : IList
return IList

GetEventTime() public method

Returns value of the field name containing the event type.
public GetEventTime ( EventFieldList eventFields ) : System.DateTime
eventFields EventFieldList
return System.DateTime

GetEventType() public method

Returns value of the field name containing the event type.
public GetEventType ( EventFieldList eventFields ) : INode
eventFields EventFieldList
return INode

GetFieldName() public method

Returns the field name the specified SelectClause in the EventFilter.
public GetFieldName ( int index ) : string
index int
return string

GetFieldValue() public method

Returns value of the field name containing the event type.
public GetFieldValue ( EventFieldList eventFields, NodeId eventTypeId, IList browsePath, uint attributeId ) : object
eventFields EventFieldList
eventTypeId NodeId
browsePath IList
attributeId uint
return object

GetFieldValue() public method

Returns value of the field name containing the event type.
public GetFieldValue ( EventFieldList eventFields, NodeId eventTypeId, QualifiedName browseName ) : object
eventFields EventFieldList
eventTypeId NodeId
browseName QualifiedName
return object

GetFieldValue() public method

Returns value of the field name containing the event type.
public GetFieldValue ( EventFieldList eventFields, NodeId eventTypeId, string browsePath, uint attributeId ) : object
eventFields EventFieldList
eventTypeId NodeId
browsePath string
attributeId uint
return object

GetServiceResult() public static method

The service result for a data change notification.
public static GetServiceResult ( IEncodeable notification ) : ServiceResult
notification IEncodeable
return ServiceResult

GetServiceResult() public static method

The service result for a field in an notification (the field must contain a Status object).
public static GetServiceResult ( IEncodeable notification, int index ) : ServiceResult
notification IEncodeable
index int
return ServiceResult

MonitoredItem() public method

Initializes a new instance of the MonitoredItem class.
public MonitoredItem ( ) : System
return System

MonitoredItem() public method

Initializes a new instance of the MonitoredItem class.
public MonitoredItem ( MonitoredItem template ) : System
template MonitoredItem The template used to specify the monitoring parameters.
return System

MonitoredItem() public method

Initializes a new instance of the MonitoredItem class.
public MonitoredItem ( MonitoredItem template, bool copyEventHandlers ) : System
template MonitoredItem The template used to specify the monitoring parameters.
copyEventHandlers bool if set to true the event handlers are copied.
return System

MonitoredItem() public method

Initializes a new instance of the MonitoredItem class.
public MonitoredItem ( uint clientHandle ) : System
clientHandle uint The client handle. The caller must ensure it uniquely identifies the monitored item.
return System

SaveValueInCache() public method

Saves a data change or event in the cache.
public SaveValueInCache ( IEncodeable newValue ) : void
newValue IEncodeable
return void

SetCreateResult() public method

Updates the object with the results of a create monitored item request.
public SetCreateResult ( MonitoredItemCreateRequest request, MonitoredItemCreateResult result, int index, DiagnosticInfoCollection diagnosticInfos, ResponseHeader responseHeader ) : void
request MonitoredItemCreateRequest
result MonitoredItemCreateResult
index int
diagnosticInfos DiagnosticInfoCollection
responseHeader ResponseHeader
return void

SetDeleteResult() public method

Updates the object with the results of a modify monitored item request.
public SetDeleteResult ( StatusCode result, int index, DiagnosticInfoCollection diagnosticInfos, ResponseHeader responseHeader ) : void
result StatusCode
index int
diagnosticInfos DiagnosticInfoCollection
responseHeader ResponseHeader
return void

SetError() public method

Sets the error status for the monitored item.
public SetError ( ServiceResult error ) : void
error ServiceResult
return void

SetModifyResult() public method

Updates the object with the results of a modify monitored item request.
public SetModifyResult ( MonitoredItemModifyRequest request, MonitoredItemModifyResult result, int index, DiagnosticInfoCollection diagnosticInfos, ResponseHeader responseHeader ) : void
request MonitoredItemModifyRequest
result MonitoredItemModifyResult
index int
diagnosticInfos DiagnosticInfoCollection
responseHeader ResponseHeader
return void

SetResolvePathResult() public method

Updates the object with the results of a translate browse path request.
public SetResolvePathResult ( BrowsePathResult result, int index, DiagnosticInfoCollection diagnosticInfos, ResponseHeader responseHeader ) : void
result BrowsePathResult
index int
diagnosticInfos DiagnosticInfoCollection
responseHeader ResponseHeader
return void