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

An object that manages aggregate factories supported by the server. More...

Inherits IDisposable.

Public Member Functions

 AggregateManager (ServerManager server)
 Initilizes the manager. More...
 
void Dispose ()
 Frees any unmanaged resources. More...
 
bool IsSupported (NodeId aggregateId)
 Checks if the aggregate is supported by the server. More...
 
AggregateConfiguration GetDefaultConfiguration (NodeId variableId)
 Returns the default configuration for the specified variable id. More...
 
void SetDefaultConfiguration (AggregateConfiguration configuration)
 Sets the default aggregate configuration. More...
 
IAggregateCalculator CreateCalculator (NodeId aggregateId, DateTime startTime, DateTime endTime, double processingInterval, bool stepped, AggregateConfiguration configuration)
 Creates a new aggregate calculator. More...
 
void RegisterFactory (NodeId aggregateId, string aggregateName, AggregatorFactory factory)
 Registers an aggregate factory. More...
 
void RegisterFactory (NodeId aggregateId)
 Unregisters an aggregate factory. More...
 

Protected Member Functions

virtual void Dispose (bool disposing)
 An overrideable version of the Dispose. More...
 

Properties

double MinimumProcessingInterval [get, set]
 The minimum processing interval for any aggregate calculation. More...
 

Detailed Description

An object that manages aggregate factories supported by the server.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.AggregateManager.AggregateManager ( ServerManager  server)

Initilizes the manager.

Member Function Documentation

IAggregateCalculator UnifiedAutomation.UaServer.AggregateManager.CreateCalculator ( NodeId  aggregateId,
DateTime  startTime,
DateTime  endTime,
double  processingInterval,
bool  stepped,
AggregateConfiguration  configuration 
)

Creates a new aggregate calculator.

Parameters
aggregateIdThe id of the aggregate function.
startTimeWhen to start processing.
endTimeWhen to stop processing.
processingIntervalThe processing interval.
steppedWhether stepped interpolation should be used.
configurationThe configuaration to use.
Returns
void UnifiedAutomation.UaServer.AggregateManager.Dispose ( )

Frees any unmanaged resources.

virtual void UnifiedAutomation.UaServer.AggregateManager.Dispose ( bool  disposing)
protectedvirtual

An overrideable version of the Dispose.

AggregateConfiguration UnifiedAutomation.UaServer.AggregateManager.GetDefaultConfiguration ( NodeId  variableId)

Returns the default configuration for the specified variable id.

Parameters
variableIdThe id of history data node.
Returns
The configuration.
bool UnifiedAutomation.UaServer.AggregateManager.IsSupported ( NodeId  aggregateId)

Checks if the aggregate is supported by the server.

Parameters
aggregateIdThe id of the aggregate function.
Returns
True if the aggregate is supported.
void UnifiedAutomation.UaServer.AggregateManager.RegisterFactory ( NodeId  aggregateId,
string  aggregateName,
AggregatorFactory  factory 
)

Registers an aggregate factory.

Parameters
aggregateIdThe id of the aggregate function.
aggregateNameThe id of the aggregate name.
factoryThe factory used to create calculators.
void UnifiedAutomation.UaServer.AggregateManager.RegisterFactory ( NodeId  aggregateId)

Unregisters an aggregate factory.

Parameters
aggregateIdThe id of the aggregate function.
void UnifiedAutomation.UaServer.AggregateManager.SetDefaultConfiguration ( AggregateConfiguration  configuration)

Sets the default aggregate configuration.

Parameters
configurationThe default aggregate configuration..

Property Documentation

double UnifiedAutomation.UaServer.AggregateManager.MinimumProcessingInterval
getset

The minimum processing interval for any aggregate calculation.


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