UA Bundle SDK .NET
2.4.0.361
|
A monitored item for a subscription. More...
Public Member Functions | |
MonitoredItem (RequestContext context, TimestampsToReturn timestampsToReturn, MonitoringMode monitoringMode, uint clientHandle, uint queueSize, bool discardOldest) | |
Initializes a new instance of the MonitoredItem class. More... | |
MonitoringParameters | GetMonitoringParameters () |
Gets the monitoring parameters. More... | |
bool | SetTriggered () |
Sets a flag indicating that the item has been triggered and should publish. More... | |
MonitoringMode | SetMonitoringMode (MonitoringMode monitoringMode) |
Changes the monitoring mode for the item. More... | |
bool | Publish (RequestContext context, Queue< MonitoredItemNotification > notifications) |
Publishes all available data change notifications. More... | |
virtual bool | Publish (RequestContext context, Queue< EventFieldList > notifications) |
Publishes all available event notifications. More... | |
void | OnDataChanged (RequestContext context, MonitoredItemHandle itemHandle, DataValue dataValue, bool doNotBlockThread) |
Called when [data changed]. More... | |
void | OnEvent (RequestContext context, MonitoredItemHandle itemHandle, GenericEvent e, bool doNotBlockThread) |
Called when [event changed]. More... | |
void | RequeueLastValue () |
Requeues the last value. More... | |
bool | QueueEvent (RequestContext context, GenericEvent e, bool bypassFilter) |
Updates the queue with an event. More... | |
MonitoredItemCreateResult | CreationComplete (MonitoredItemHandle itemHandle, WaitCallback callback, object callbackData, DataMonitoringResult result) |
Called when the monitored item has been created successfully. More... | |
MonitoredItemCreateResult | CreationComplete (MonitoredItemHandle itemHandle, WaitCallback callback, object callbackData, EventMonitoringResult result) |
Called when the monitored item has been created successfully. More... | |
MonitoredItemModifyResult | ModificationComplete (TimestampsToReturn timestampsToReturn, DataMonitoringResult result) |
Called when an item was successfully modified. More... | |
MonitoredItemModifyResult | ModificationComplete (EventMonitoringResult result) |
Called when an item was successfully modified. More... | |
Static Public Member Functions | |
static bool | ValueChanged (DataValue value, DataValue lastValue, DataChangeFilter filter, double range) |
Applies the filter to value to determine if the new value should be kept. More... | |
Protected Member Functions | |
virtual bool | ApplyFilter (DataValue value) |
Applies the filter to value to determine if the new value should be kept. More... | |
void | InitializeQueue () |
Clears and re-initializes the queue if the monitoring parameters changed. More... | |
Static Protected Member Functions | |
static bool | Equals (object value1, object value2, DeadbandType deadbandType, double deadband, double range) |
Checks if the two values are equal. More... | |
static bool | ExceedsDeadband (object value1, object value2, DeadbandType deadbandType, double deadband, double range) |
Returns true if the deadband was exceeded. More... | |
Properties | |
uint | Id [get] |
Gets the item id. More... | |
MonitoredItemHandle | ItemHandle [get] |
Gets the item handle. More... | |
bool | IsEventItem [get] |
A flag indicating that the item is monitoring events. More... | |
uint | ClientHandle [get] |
Gets the client handle. More... | |
MonitoringMode | MonitoringMode [get] |
Gets the monitoring mode. More... | |
bool | IsReadyToPublish [get] |
Returns true if the item is ready to publish. More... | |
bool | Deleted [get, set] |
Gets or sets a value indicating whether this MonitoredItem is deleted. More... | |
List< MonitoredItem > | TriggeredItems [get, set] |
Gets or sets the triggered items for the item. More... | |
A monitored item for a subscription.
|
inline |
Initializes a new instance of the MonitoredItem class.
context | The request context. |
timestampsToReturn | The timestamps to return. |
monitoringMode | The monitoring mode. |
clientHandle | The client handle. |
queueSize | Size of the queue. |
discardOldest | if set to true [discard oldest]. |
|
inlineprotectedvirtual |
Applies the filter to value to determine if the new value should be kept.
|
inline |
Called when the monitored item has been created successfully.
itemHandle | The item handle. |
callback | The callback. |
callbackData | The callback data. |
result | The result. |
|
inline |
Called when the monitored item has been created successfully.
itemHandle | The item handle. |
callback | The callback. |
callbackData | The callback data. |
result | The result. |
|
inlinestaticprotected |
Checks if the two values are equal.
|
inlinestaticprotected |
Returns true if the deadband was exceeded.
|
inline |
Gets the monitoring parameters.
|
inlineprotected |
Clears and re-initializes the queue if the monitoring parameters changed.
|
inline |
Called when an item was successfully modified.
|
inline |
Called when an item was successfully modified.
|
inline |
Called when [data changed].
context | The request context. |
itemHandle | The item handle. |
dataValue | The data value. |
doNotBlockThread | if set to true then the current thread should not be blocked. |
|
inline |
Called when [event changed].
context | The request context. |
itemHandle | The item handle. |
e | The event. |
doNotBlockThread | if set to true then the current thread should not be blocked. |
|
inline |
Publishes all available data change notifications.
|
inlinevirtual |
Publishes all available event notifications.
|
inline |
Updates the queue with an event.
|
inline |
Requeues the last value.
|
inline |
Changes the monitoring mode for the item.
|
inline |
Sets a flag indicating that the item has been triggered and should publish.
|
inlinestatic |
Applies the filter to value to determine if the new value should be kept.
|
get |
Gets the client handle.
|
getset |
Gets or sets a value indicating whether this MonitoredItem is deleted.
true
if deleted; otherwise, false
.
|
get |
Gets the item id.
|
get |
A flag indicating that the item is monitoring events.
|
get |
Returns true if the item is ready to publish.
|
get |
Gets the item handle.
|
get |
Gets the monitoring mode.
|
getset |
Gets or sets the triggered items for the item.
The triggered items.
The caller must ensure access to the collection is thread safe.