UA Bundle SDK .NET  2.2.0.255
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaServer.MonitoredItemQueue Class Reference

Provides a queue for data changes. More...

Public Member Functions

 MonitoredItemQueue ()
 Creates an empty queue. More...
 
void SetSamplingInterval (double samplingInterval)
 Sets the sampling interval used when queuing values. More...
 
void SetQueueSize (uint queueSize, bool discardOldest)
 Sets the queue size. More...
 
void QueueValue (DataValue value)
 Adds the value to the queue. More...
 
bool Publish (out DataValue value)
 Publishes the oldest value in the queue. More...
 

Properties

uint QueueSize [get]
 Gets the current queue size. More...
 
int ItemsInQueue [get]
 Gets number of elements actually contained in value queue. More...
 

Detailed Description

Provides a queue for data changes.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.MonitoredItemQueue.MonitoredItemQueue ( )
inline

Creates an empty queue.

Member Function Documentation

bool UnifiedAutomation.UaServer.MonitoredItemQueue.Publish ( out DataValue  value)
inline

Publishes the oldest value in the queue.

Parameters
valueThe value.
Returns
True if a value was found. False if the queue is empty.
void UnifiedAutomation.UaServer.MonitoredItemQueue.QueueValue ( DataValue  value)
inline

Adds the value to the queue.

Parameters
valueThe value to queue.
void UnifiedAutomation.UaServer.MonitoredItemQueue.SetQueueSize ( uint  queueSize,
bool  discardOldest 
)
inline

Sets the queue size.

Parameters
queueSizeThe new queue size.
discardOldestWhether to discard the oldest values if the queue overflows.
void UnifiedAutomation.UaServer.MonitoredItemQueue.SetSamplingInterval ( double  samplingInterval)
inline

Sets the sampling interval used when queuing values.

Parameters
samplingIntervalThe new sampling interval.

Property Documentation

int UnifiedAutomation.UaServer.MonitoredItemQueue.ItemsInQueue
get

Gets number of elements actually contained in value queue.

uint UnifiedAutomation.UaServer.MonitoredItemQueue.QueueSize
get

Gets the current queue size.


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