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

Public Member Functions

def __init__ (self, str node_address)
 
str get_event_type (self)
 
str get_node (self)
 
NotifyTypePublish get_notify_type (self)
 
int get_sequence_number (self)
 
str get_source_name (self)
 
def get_timestamp (self)
 
def set_event_type (self, str et)
 
def set_notify_type (self, NotifyTypePublish nt)
 
def set_sequence_number (self, int sn)
 
def set_source_name (self, str source)
 
def set_timestamp (self, datetime.datetime dt)
 

Detailed Description

NotifyInfoPublish.

containing notify_info.fbs (address, timestamp, type, ...)

Definition at line 76 of file provider_subscription.py.

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_event_type()

str get_event_type (   self)

get_event_type

Returns
str:

Definition at line 152 of file provider_subscription.py.

References NotifyInfoPublish.__event_type.

◆ get_node()

str get_node (   self)

get_node

Returns
str node address

Definition at line 99 of file provider_subscription.py.

References NotifyInfoPublish.__node.

◆ get_notify_type()

NotifyTypePublish get_notify_type (   self)

get_notify_type

Returns
NotifyTypePublish

Definition at line 133 of file provider_subscription.py.

References NotifyInfoPublish.__notify_type.

◆ get_sequence_number()

int get_sequence_number (   self)

get_sequence_number

Returns
int:

Definition at line 169 of file provider_subscription.py.

References NotifyInfoPublish.__sequence_number.

◆ get_source_name()

str get_source_name (   self)

get_source_name

Returns
str:

Definition at line 187 of file provider_subscription.py.

References NotifyInfoPublish.__source_name.

◆ get_timestamp()

def get_timestamp (   self)

get_timestamp

Returns
datetime.datetime:

Definition at line 116 of file provider_subscription.py.

References Response.__timestamp, and NotifyInfoPublish.__timestamp.

◆ set_event_type()

def set_event_type (   self,
str  et 
)

set_event_type In case of an event, this string contains the information what EventType has been fired.

E "types/events/ExampleEvent"

    et (str):

Definition at line 143 of file provider_subscription.py.

References NotifyInfoPublish.__event_type.

◆ set_notify_type()

def set_notify_type (   self,
NotifyTypePublish  nt 
)

set_notify_type

        nt (NotifyTypePublish):

Definition at line 124 of file provider_subscription.py.

References NotifyInfoPublish.__notify_type.

◆ set_sequence_number()

def set_sequence_number (   self,
int  sn 
)

set_sequence_number sequence number of an event

Parameters
sn0 default

Definition at line 160 of file provider_subscription.py.

References NotifyInfoPublish.__sequence_number.

◆ set_source_name()

def set_source_name (   self,
str  source 
)

set_source_name description of the source of an event

        source (str):

Definition at line 178 of file provider_subscription.py.

References NotifyInfoPublish.__source_name.

◆ set_timestamp()

def set_timestamp (   self,
datetime.datetime  dt 
)

set_timestamp

        dt (datetime.datetime):

Definition at line 107 of file provider_subscription.py.

References Response.__timestamp, and NotifyInfoPublish.__timestamp.

Referenced by Variant.set_datetime().