ctrlX Data Layer API for Python  3.3.0
The ctrlX Data Layer API allows access to the ctrlX Data Layer with Python
SubscriptionPropertiesBuilder Class Reference

Public Member Functions

def __init__ (self, str id_val)
 
def add_rule_changeevents (self, ChangeEvents.ChangeEventsT rule)
 
def add_rule_counting (self, Counting.CountingT rule)
 
def add_rule_datachangefilter (self, DataChangeFilter.DataChangeFilterT rule)
 
def add_rule_losslessratelimit (self, LosslessRateLimit.LosslessRateLimitT rule)
 
def add_rule_queueing (self, Queueing.QueueingT rule)
 
def add_rule_sampling (self, Sampling.SamplingT rule)
 
Variant build (self)
 
def set_error_interval (self, int interval)
 
def set_keepalive_interval (self, int interval)
 
def set_publish_interval (self, int interval)
 

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ add_rule_changeevents()

def add_rule_changeevents (   self,
ChangeEvents.ChangeEventsT  rule 
)

add_rule_changeevents

        rule (ChangeEvents.ChangeEventsT):

Definition at line 123 of file subscription_properties_builder.py.

References SubscriptionPropertiesBuilder.__rules.

◆ add_rule_counting()

def add_rule_counting (   self,
Counting.CountingT  rule 
)

add_rule_counting

        rule (Counting.CountingT):

Definition at line 135 of file subscription_properties_builder.py.

References SubscriptionPropertiesBuilder.__rules.

◆ add_rule_datachangefilter()

def add_rule_datachangefilter (   self,
DataChangeFilter.DataChangeFilterT  rule 
)

add_rule_datachangefilter

        rule (DataChangeFilter.DataChangeFilterT):

Definition at line 111 of file subscription_properties_builder.py.

References SubscriptionPropertiesBuilder.__rules.

◆ add_rule_losslessratelimit()

def add_rule_losslessratelimit (   self,
LosslessRateLimit.LosslessRateLimitT  rule 
)

add_rule_losslessratelimit

        rule (LosslessRateLimit.LosslessRateLimitT):

Definition at line 147 of file subscription_properties_builder.py.

References SubscriptionPropertiesBuilder.__rules.

◆ add_rule_queueing()

def add_rule_queueing (   self,
Queueing.QueueingT  rule 
)

add_rule_queueing

        rule (Queueing.QueueingT):

Definition at line 99 of file subscription_properties_builder.py.

References SubscriptionPropertiesBuilder.__rules.

◆ add_rule_sampling()

def add_rule_sampling (   self,
Sampling.SamplingT  rule 
)

add_rule_sampling

   !!!Hint: 'samplingInterval = 0' only RT nodes, see "datalayer/nodesrt"

       rule (Sampling.SamplingT):

Definition at line 87 of file subscription_properties_builder.py.

References SubscriptionPropertiesBuilder.__rules.

◆ build()

◆ set_error_interval()

def set_error_interval (   self,
int  interval 
)

set_error_interval

Parameters
intervalerror interval

Definition at line 77 of file subscription_properties_builder.py.

References SubscriptionPropertiesBuilder.__error_interval.

◆ set_keepalive_interval()

def set_keepalive_interval (   self,
int  interval 
)

set_keepalive_interval

Parameters
intervalkeep alvive interval

Definition at line 59 of file subscription_properties_builder.py.

References SubscriptionPropertiesBuilder.__keepalive_interval.

◆ set_publish_interval()

def set_publish_interval (   self,
int  interval 
)

set_publish_interval

Parameters
intervalpublish interval

Definition at line 68 of file subscription_properties_builder.py.

References SubscriptionPropertiesBuilder.__publish_interval.