Public Member Functions
opcua.server.history.HistoryStorageInterface Class Reference
Inheritance diagram for opcua.server.history.HistoryStorageInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def new_historized_event
def new_historized_node
def read_event_history
def read_node_history
def save_event
def save_node_value
def stop

Detailed Description

Interface of a history backend.
Must be implemented by backends

Definition at line 14 of file history.py.


Member Function Documentation

def opcua.server.history.HistoryStorageInterface.new_historized_event (   self,
  source_id,
  evtypes,
  period,
  count = 0 
)
Called when historization of events is enabled on server side
Returns None

Reimplemented in opcua.server.history_sql.HistorySQLite, and opcua.server.history.HistoryDict.

Definition at line 46 of file history.py.

def opcua.server.history.HistoryStorageInterface.new_historized_node (   self,
  node_id,
  period,
  count = 0 
)
Called when a new node is to be historized
Returns None

Reimplemented in opcua.server.history.HistoryDict, and opcua.server.history_sql.HistorySQLite.

Definition at line 21 of file history.py.

def opcua.server.history.HistoryStorageInterface.read_event_history (   self,
  source_id,
  start,
  end,
  nb_values,
  evfilter 
)
Called when a client make a history read request for events
Start time and end time are inclusive
Returns a list of Events and a continuation point which
is None if all events are read or the ServerTimeStamp of the last rejected event

Reimplemented in opcua.server.history_sql.HistorySQLite, and opcua.server.history.HistoryDict.

Definition at line 60 of file history.py.

def opcua.server.history.HistoryStorageInterface.read_node_history (   self,
  node_id,
  start,
  end,
  nb_values 
)
Called when a client make a history read request for a node
if start or end is missing then nb_values is used to limit query
nb_values is the max number of values to read. Ignored if 0
Start time and end time are inclusive
Returns a list of DataValues and a continuation point which
is None if all nodes are read or the ServerTimeStamp of the last rejected DataValue

Reimplemented in opcua.server.history.HistoryDict, and opcua.server.history_sql.HistorySQLite.

Definition at line 35 of file history.py.

Called when a new event has been generated ans should be saved in history
Returns None

Reimplemented in opcua.server.history_sql.HistorySQLite, and opcua.server.history.HistoryDict.

Definition at line 53 of file history.py.

def opcua.server.history.HistoryStorageInterface.save_node_value (   self,
  node_id,
  datavalue 
)
Called when the value of a historized node has changed and should be saved in history
Returns None

Reimplemented in opcua.server.history.HistoryDict, and opcua.server.history_sql.HistorySQLite.

Definition at line 28 of file history.py.

Called when the server shuts down
Can be used to close database connections etc.

Reimplemented in opcua.server.history_sql.HistorySQLite, and opcua.server.history.HistoryDict.

Definition at line 69 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 Sat Jun 8 2019 18:26:24