Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
opcua.server.history.HistoryManager Class Reference
Inheritance diagram for opcua.server.history.HistoryManager:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, iserver)
 
def dehistorize (self, node)
 
def historize_data_change (self, node, period=timedelta(days=7), count=0)
 
def historize_event (self, source, period=timedelta(days=7), count=0)
 
def read_history (self, params)
 
def set_storage (self, storage)
 
def stop (self)
 
def update_history (self, params)
 

Public Attributes

 iserver
 
 logger
 
 storage
 

Private Member Functions

def _create_subscription (self, handler)
 
def _read_datavalue_history (self, rv, details)
 
def _read_event_history (self, rv, details)
 
def _read_history (self, details, rv)
 

Private Attributes

 _handlers
 
 _sub
 

Detailed Description

Definition at line 185 of file history.py.

Constructor & Destructor Documentation

def opcua.server.history.HistoryManager.__init__ (   self,
  iserver 
)

Definition at line 186 of file history.py.

Member Function Documentation

def opcua.server.history.HistoryManager._create_subscription (   self,
  handler 
)
private

Definition at line 199 of file history.py.

def opcua.server.history.HistoryManager._read_datavalue_history (   self,
  rv,
  details 
)
private

Definition at line 301 of file history.py.

def opcua.server.history.HistoryManager._read_event_history (   self,
  rv,
  details 
)
private

Definition at line 320 of file history.py.

def opcua.server.history.HistoryManager._read_history (   self,
  details,
  rv 
)
private
determine if the history read is for a data changes or events; then read the history for that node

Definition at line 273 of file history.py.

def opcua.server.history.HistoryManager.dehistorize (   self,
  node 
)
Remove subscription to the node/source which is being historized

SQL Implementation
Only the subscriptions is removed. The historical data remains.

Definition at line 247 of file history.py.

def opcua.server.history.HistoryManager.historize_data_change (   self,
  node,
  period = timedelta(days=7),
  count = 0 
)
Subscribe to the nodes' data changes and store the data in the active storage.

Definition at line 209 of file history.py.

def opcua.server.history.HistoryManager.historize_event (   self,
  source,
  period = timedelta(days=7),
  count = 0 
)
Subscribe to the source nodes' events and store the data in the active storage.

SQL Implementation
The default is to historize every event type the source generates, custom event properties are included. At
this time there is no way to historize a specific event type. The user software can filter out events which are
not desired when reading.

Note that adding custom events to a source node AFTER historizing has been activated is not supported at this
time (in SQL history there will be no columns in the SQL table for the new event properties). For SQL The table
must be deleted manually so that a new table with the custom event fields can be created.

Definition at line 221 of file history.py.

def opcua.server.history.HistoryManager.read_history (   self,
  params 
)
Read history for a node
This is the part AttributeService, but implemented as its own service
since it requires more logic than other attribute service methods

Definition at line 260 of file history.py.

def opcua.server.history.HistoryManager.set_storage (   self,
  storage 
)
set the desired HistoryStorageInterface which History Manager will use for historizing

Definition at line 193 of file history.py.

def opcua.server.history.HistoryManager.stop (   self)
call stop methods of active storage interface whenever the server is stopped

Definition at line 357 of file history.py.

def opcua.server.history.HistoryManager.update_history (   self,
  params 
)
Update history for a node
This is the part AttributeService, but implemented as its own service
since it requires more logic than other attribute service methods

Definition at line 343 of file history.py.

Member Data Documentation

opcua.server.history.HistoryManager._handlers
private

Definition at line 191 of file history.py.

opcua.server.history.HistoryManager._sub
private

Definition at line 190 of file history.py.

opcua.server.history.HistoryManager.iserver

Definition at line 188 of file history.py.

opcua.server.history.HistoryManager.logger

Definition at line 187 of file history.py.

opcua.server.history.HistoryManager.storage

Definition at line 189 of file history.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