Public Member Functions | Static Public Member Functions | Public Attributes | Static Private Attributes | List of all members
opcua.common.events.Event Class Reference
Inheritance diagram for opcua.common.events.Event:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self)
 
def __str__ (self)
 
def add_property (self, name, val, datatype)
 
def get_event_props_as_fields_dict (self)
 
def to_event_fields (self, select_clauses)
 
def to_event_fields_using_subscription_fields (self, select_clauses)
 

Static Public Member Functions

def from_event_fields (select_clauses, fields)
 
def from_field_dict (fields)
 

Public Attributes

 data_types
 
 event_fields
 
 internal_properties
 
 select_clauses
 
 server_handle
 

Static Private Attributes

 __repr__ = __str__
 

Detailed Description

OPC UA Event object.
This is class in inherited by the common event objects such as BaseEvent,
other auto standard events and custom events
Events are used to trigger events on server side and are
sent to clients for every events from server

Developper Warning:
On server side the data type of attributes should be known, thus
add properties using the add_property method!!!

Definition at line 9 of file events.py.

Constructor & Destructor Documentation

def opcua.common.events.Event.__init__ (   self)

Definition at line 22 of file events.py.

Member Function Documentation

def opcua.common.events.Event.__str__ (   self)

Definition at line 30 of file events.py.

def opcua.common.events.Event.add_property (   self,
  name,
  val,
  datatype 
)
Add a property to event and tore its data type

Definition at line 36 of file events.py.

def opcua.common.events.Event.from_event_fields (   select_clauses,
  fields 
)
static
Instantiate an Event object from a select_clauses and fields

Definition at line 96 of file events.py.

def opcua.common.events.Event.from_field_dict (   fields)
static
Create an Event object from a dict of name and variants

Definition at line 54 of file events.py.

def opcua.common.events.Event.get_event_props_as_fields_dict (   self)
convert all properties of the Event class to a dict of variants

Definition at line 43 of file events.py.

def opcua.common.events.Event.to_event_fields (   self,
  select_clauses 
)
return a field list using a select clause and the object properties

Definition at line 76 of file events.py.

def opcua.common.events.Event.to_event_fields_using_subscription_fields (   self,
  select_clauses 
)
Using a new select_clauses and the original select_clauses
used during subscription, return a field list 

Definition at line 63 of file events.py.

Member Data Documentation

opcua.common.events.Event.__repr__ = __str__
staticprivate

Definition at line 34 of file events.py.

opcua.common.events.Event.data_types

Definition at line 26 of file events.py.

opcua.common.events.Event.event_fields

Definition at line 25 of file events.py.

opcua.common.events.Event.internal_properties

Definition at line 28 of file events.py.

opcua.common.events.Event.select_clauses

Definition at line 24 of file events.py.

opcua.common.events.Event.server_handle

Definition at line 23 of file events.py.


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


ros_opcua_impl_python_opcua
Author(s): Denis Štogl , Daniel Draper
autogenerated on Tue Jan 19 2021 03:12:44