AutomaticPublishingFactor Property (EasyUAClientEngineParameters)

Automatic publishing factor that the component uses to determine the publishing interval.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<DataMemberAttribute()>
<ValueRangeAttribute(1.401298E-45, 3.402823E+38)>
Public Property AutomaticPublishingFactor As Single

'Usage
 
Dim instance As EasyUAClientEngineParameters
Dim value As Single
 
instance.AutomaticPublishingFactor = value
 
value = instance.AutomaticPublishingFactor

[DataMember()]
[ValueRange(1.401298E-45, 3.402823E+38)]
public float AutomaticPublishingFactor {get; set;}

[DataMember()]
[ValueRange(1.401298E-45, 3.402823E+38)]
public:
property float AutomaticPublishingFactor {
   float get();
   void set (    float value);
}

Property Value

Valid values of this property are in the range from 1.401298E-45 (Single.Epsilon) to 3.402823E+38 (Single.MaxValue).

The default value of this property is 2.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Exception

Description

System.ArgumentOutOfRangeException

The value of an argument is outside the allowable range of values as defined by the invoked method.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

If you do not specify the publishing interval (if it is set to zero in OpcLabs.EasyOpc.UA.UASubscriptionParameters.PublishingInterval), the component will calculate it by dividing the sampling interval by this factor. The resulting value is limited by FastestAutomaticPublishingInterval.

By default, the publishing interval equals to one half of the sampling interval.

In order to obtain or modify this parameter, access the EasyUAClientSharedParameters.EngineParameters property of static OpcLabs.EasyOpc.UA.EasyUAClientCore.SharedParameters.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

EasyUAClientEngineParameters Class
EasyUAClientEngineParameters Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.