SubscriptionPropertiesBuilder Class Reference

Provides a convenient way to build a SubscriptionProperties flatbuffers. More...

Public Member Functions
	SubscriptionPropertiesBuilder (string id)
	Initializes a new instance of the SubscriptionPropertiesBuilder class.
Variant	Build ()
	Builds this the SubscriptionProperties as flatbuffers object.
SubscriptionPropertiesBuilder	SetChangeEvents (DataChangeTrigger dataChangeTrigger, bool browselistChange=false, bool metadataChange=false)
	Sets the change events.
SubscriptionPropertiesBuilder	SetCounting (bool countSubscriptions)
	Sets the counting.
SubscriptionPropertiesBuilder	SetDataChangeFilter (float deadbandValue)
	Sets the data change filter.
SubscriptionPropertiesBuilder	SetErrorIntervalMillis (uint errorIntervalMillis)
	Sets the error interval in milliseconds.
SubscriptionPropertiesBuilder	SetKeepAliveIntervalMillis (uint keepAliveIntervalMillis)
	Sets the keep alive interval in milliseconds.
SubscriptionPropertiesBuilder	SetPublishIntervalMillis (uint publishIntervalMillis)
	Sets the publish interval in milliseconds.
SubscriptionPropertiesBuilder	SetQueueing (uint queueSize, QueueBehaviour queueBehaviour)
	Sets the queueing.
SubscriptionPropertiesBuilder	SetSamplingIntervalMicros (ulong samplingIntervalMicros)
	Sets the sampling interval in microseconds.
SubscriptionPropertiesBuilder	SetSamplingIntervalMillis (ulong samplingIntervalMillis)
	Sets the sampling interval in milliseconds.

Detailed Description

Provides a convenient way to build a SubscriptionProperties flatbuffers.

Definition at line 10 of file SubscriptionPropertiesBuilder.cs.

Constructor & Destructor Documentation

SubscriptionPropertiesBuilder()

SubscriptionPropertiesBuilder ( string  id )

inline

Initializes a new instance of the SubscriptionPropertiesBuilder class.

Parameters

id	The identifier.

Definition at line 60 of file SubscriptionPropertiesBuilder.cs.

References Variant.DefaultFlatbuffersInitialSize.

Member Function Documentation

Build()

Variant Build ( )

inline

Builds this the SubscriptionProperties as flatbuffers object.

Returns

The SubscriptionPropertiesBuilder instance.

Definition at line 201 of file SubscriptionPropertiesBuilder.cs.

SetChangeEvents()

SubscriptionPropertiesBuilder SetChangeEvents ( DataChangeTrigger  dataChangeTrigger, bool  browselistChange = false, bool  metadataChange = false  )

inline

Sets the change events.

Parameters

dataChangeTrigger	The data change trigger.
browselistChange	if set to true the change event is raised if the browse list changed.
metadataChange	if set to true the change event is raised if the meta data changed.

Returns

The SubscriptionPropertiesBuilder instance.

Definition at line 160 of file SubscriptionPropertiesBuilder.cs.

SetCounting()

SubscriptionPropertiesBuilder SetCounting ( bool  countSubscriptions )

inline

Sets the counting.

Parameters

countSubscriptions

if set to true nodes are counted if subscribed multiple times.

Returns

The SubscriptionPropertiesBuilder instance.

Definition at line 189 of file SubscriptionPropertiesBuilder.cs.

SetDataChangeFilter()

SubscriptionPropertiesBuilder SetDataChangeFilter ( float  deadbandValue )

inline

Sets the data change filter.

Parameters

deadbandValue

The deadband value.

Returns

The SubscriptionPropertiesBuilder instance.

Definition at line 144 of file SubscriptionPropertiesBuilder.cs.

SetErrorIntervalMillis()

SubscriptionPropertiesBuilder SetErrorIntervalMillis ( uint  errorIntervalMillis )

inline

Sets the error interval in milliseconds.

Parameters

errorIntervalMillis

The error interval in milliseconds.

Returns

The SubscriptionPropertiesBuilder instance.

Definition at line 106 of file SubscriptionPropertiesBuilder.cs.

SetKeepAliveIntervalMillis()

SubscriptionPropertiesBuilder SetKeepAliveIntervalMillis ( uint  keepAliveIntervalMillis )

inline

Sets the keep alive interval in milliseconds.

Parameters

keepAliveIntervalMillis

The keep alive interval in milliseconds.

Returns

The SubscriptionPropertiesBuilder instance.

Definition at line 84 of file SubscriptionPropertiesBuilder.cs.

SetPublishIntervalMillis()

SubscriptionPropertiesBuilder SetPublishIntervalMillis ( uint  publishIntervalMillis )

inline

Sets the publish interval in milliseconds.

Parameters

publishIntervalMillis

The publish interval in milliseconds.

Returns

The SubscriptionPropertiesBuilder instance.

Definition at line 95 of file SubscriptionPropertiesBuilder.cs.

SetQueueing()

SubscriptionPropertiesBuilder SetQueueing ( uint  queueSize, QueueBehaviour  queueBehaviour  )

inline

Sets the queueing.

Parameters

queueSize	Size of the queue.
queueBehaviour	The queue behaviour.

Returns

The SubscriptionPropertiesBuilder instance.

Definition at line 176 of file SubscriptionPropertiesBuilder.cs.

SetSamplingIntervalMicros()

SubscriptionPropertiesBuilder SetSamplingIntervalMicros ( ulong  samplingIntervalMicros )

inline

Sets the sampling interval in microseconds.

Parameters

samplingIntervalMicros

The sampling interval in microseconds.

Returns

The SubscriptionPropertiesBuilder instance.

Definition at line 131 of file SubscriptionPropertiesBuilder.cs.

SetSamplingIntervalMillis()

SubscriptionPropertiesBuilder SetSamplingIntervalMillis ( ulong  samplingIntervalMillis )

inline

Sets the sampling interval in milliseconds.

Parameters

samplingIntervalMillis

The sampling interval in milliseconds.

Returns

The SubscriptionPropertiesBuilder instance.

Definition at line 117 of file SubscriptionPropertiesBuilder.cs.

---

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

• D:/Jenkins/workspace/sdk.datalayer.csharp/datalayer/SubscriptionPropertiesBuilder.cs