UA Server SDK C++ Bundle
1.3.2.200
|
Interface definition of the HistoryManager used for reading, updating and deletion of data and event history. More...
#include <historymanager.h>
Inherited by HistoryManagerBase.
Public Types | |
enum | TransactionType { READ_EVENTS, READ_RAW, READ_MODIFIED, READ_PROCESSED, READ_ATTIME, UPDATE_DATA, UPDATE_EVENT, DELETE_RAW, DELETE_ATTIME, DELETE_EVENT } |
TransactionType enumeration. More... |
Public Member Functions | |
HistoryManager () | |
construction | |
virtual | ~HistoryManager () |
destruction | |
virtual UaStatus | beginHistoryTransaction (HistoryManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 hTransaction, TransactionType transactionType, OpcUa_TimestampsToReturn timestampsToReturn, OpcUa_Handle &hHistoryManagerContext)=0 |
Start a transaction. | |
virtual UaStatus | beginReadEvents (OpcUa_Handle hHistoryManagerContext, OpcUa_UInt32 callbackHandle, HistoryVariableHandle *pVariableHandle, HistoryReadCPUserDataBase *pContinuationPoint, OpcUa_UInt32 numValuesPerNode, OpcUa_DateTime &startTime, OpcUa_DateTime &endTime, const OpcUa_EventFilter &filter)=0 |
Read event history for a node. | |
virtual UaStatus | beginReadRawModified (OpcUa_Handle hHistoryManagerContext, OpcUa_UInt32 callbackHandle, HistoryVariableHandle *pVariableHandle, HistoryReadCPUserDataBase *pContinuationPoint, OpcUa_Boolean IsReadModified, OpcUa_UInt32 numValuesPerNode, OpcUa_DateTime &startTime, OpcUa_DateTime &endTime, OpcUa_Boolean returnBounds)=0 |
Read raw or modified history values for a node. | |
virtual UaStatus | beginReadProcessed (OpcUa_Handle hHistoryManagerContext, OpcUa_UInt32 callbackHandle, HistoryVariableHandle *pVariableHandle, HistoryReadCPUserDataBase *pContinuationPoint, OpcUa_DateTime &startTime, OpcUa_DateTime &endTime, OpcUa_Double processingInterval, const OpcUa_NodeId &aggregateType, OpcUa_AggregateConfiguration aggregateConfiguration)=0 |
Read processed history values for a node. | |
virtual UaStatus | beginReadAtTime (OpcUa_Handle hHistoryManagerContext, OpcUa_UInt32 callbackHandle, HistoryVariableHandle *pVariableHandle, HistoryReadCPUserDataBase *pContinuationPoint, const UaDateTimeArray &requestedTimes)=0 |
Read history values for a node at specific timestamps. | |
virtual UaStatus | beginUpdateData (OpcUa_Handle hHistoryManagerContext, OpcUa_UInt32 callbackHandle, HistoryVariableHandle *pVariableHandle, OpcUa_PerformUpdateType performInsertReplace, const UaDataValues &updateValue)=0 |
Update history values for a node. | |
virtual UaStatus | beginUpdateEvents (OpcUa_Handle hHistoryManagerContext, OpcUa_UInt32 callbackHandle, HistoryVariableHandle *pVariableHandle, OpcUa_PerformUpdateType performInsertReplace, const OpcUa_EventFilter &filter, const UaEventFieldLists &eventData)=0 |
Update history event for a node. | |
virtual UaStatus | beginDeleteRawModified (OpcUa_Handle hHistoryManagerContext, OpcUa_UInt32 callbackHandle, HistoryVariableHandle *pVariableHandle, OpcUa_Boolean isDeleteModified, OpcUa_DateTime &startTime, OpcUa_DateTime &endTime)=0 |
Delete raw or modified history values for a node. | |
virtual UaStatus | beginDeleteAtTime (OpcUa_Handle hHistoryManagerContext, OpcUa_UInt32 callbackHandle, HistoryVariableHandle *pVariableHandle, const UaDateTimeArray &requestedTimes)=0 |
Delete raw or modified history values for a node. | |
virtual UaStatus | beginDeleteEvents (OpcUa_Handle hHistoryManagerContext, OpcUa_UInt32 callbackHandle, HistoryVariableHandle *pVariableHandle, const UaByteStringArray &eventIds)=0 |
Delete events for a node. | |
virtual UaStatus | finishHistoryTransaction (OpcUa_Handle hHistoryManagerContext)=0 |
Finish a transaction. |
Interface definition of the HistoryManager used for reading, updating and deletion of data and event history.
The HistoryManager interface provides the reading, updating and deletion capabilities for data and event history. The HistoryManager interface is asynchronous. For the HistoryManager callback the HistoryManagerCallback interface is implemented by the consumer of the history data or events. One of the consumers is the UA Module. This interface is used by the SDK to multiplex the list of nodes in the UA service call to different HistoryManagers. One UA service call is a transaction for the SDK. If an HistoryManager is used in a transaction, the beginHistoryTransaction method is called by the SDK. This allows the HistoryManagers to create a context for the transactions since the SDK will call the associated begin method (e.g. beginReadRawModified) for each node in the transaction. Depending on the underlying system, the action can be started for each node in the begin method or for a list of nodes in the finishHistoryTransaction method. If the underlying system allows optimizing access for a list of nodes, the finishHistoryTransaction method should be used to start the access to the underlying system. This method is called by the SDK after calling the begin methods for all nodes in the transaction.
!!!!!
This interface may change after release 1.0 of the UA Server SDK since the corresponding OPC UA Specification is not finally released
!!!!!
TransactionType enumeration.
|
pure virtual |
Delete raw or modified history values for a node.
hHistoryManagerContext | General context for the service calls containing information like history. |
callbackHandle | Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context. |
requestedTimes | The list of timestamps to delete. |
Implemented in HistoryManagerBase.
|
pure virtual |
Delete events for a node.
hHistoryManagerContext | General context for the service calls containing information like history. |
callbackHandle | Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context. |
eventIds | The list of EventIds for the events to delete. |
Implemented in HistoryManagerBase.
|
pure virtual |
Delete raw or modified history values for a node.
hHistoryManagerContext | General context for the service calls containing information like history. |
callbackHandle | Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context. |
isDeleteModified | A flag that indicates if modified values should be deleted instead of raw value. |
startTime | The start time of the time period to delete. |
endTime | The end time of the time period to delete. |
Implemented in HistoryManagerBase.
|
pure virtual |
Start a transaction.
pCallback | Callback interface used for the transaction. The IOManager must use this interface to finish the action for each passed node in the transaction. |
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
hTransaction | Handle for the transaction used by the SDK to identify the transaction in the callbacks. This handle was passed in to the IOManager with the beginTransaction method. |
transactionType | Type of the transaction. The possible enum values are: READ, WRITE, MONITOR_BEGIN, MONITOR_MODIFY, MONITOR_STOP. |
timestampsToReturn | The client selected timestamp to return. Valid enum values are: OpcUa_TimestampsToReturn_Source, OpcUa_TimestampsToReturn_Server, OpcUa_TimestampsToReturn_Both |
hHistoryManagerContext | General context for the service calls containing information like history. |
Implemented in HistoryManagerBase.
|
pure virtual |
Read history values for a node at specific timestamps.
hHistoryManagerContext | General context for the service calls containing information like history. |
callbackHandle | Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context. |
pContinuationPoint | The continuation point data from a previous Read call. Null if first Read. Implementers of this interface can store the continuation point data in a derived class. |
requestedTimes | The requested timestamps to read. |
Implemented in HistoryManagerBase.
|
pure virtual |
Read event history for a node.
hHistoryManagerContext | General context for the service calls containing information like history. |
callbackHandle | Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context. |
pContinuationPoint | The continuation point data from a previous Read call. Null if first Read. Implementers of this interface can store the continuation point data in a derived class. |
numValuesPerNode | the Number of Values per Node. |
startTime | The start time of the time period to read. |
endTime | The end time of the time period to read. |
filter | An event filter used to select events to read. |
Implemented in HistoryManagerBase.
|
pure virtual |
Read processed history values for a node.
hHistoryManagerContext | General context for the service calls containing information like history. |
callbackHandle | Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context. |
pContinuationPoint | The continuation point data from a previous Read call. Null if first Read. Implementers of this interface can store the continuation point data in a derived class. |
startTime | The start time of the time period to read. |
endTime | The end time of the time period to read. |
processingInterval | the interval to re sample. |
aggregateType | the aggregate type node id. |
aggregateConfiguration | The aggregate configuration. |
Implemented in HistoryManagerBase.
|
pure virtual |
Read raw or modified history values for a node.
hHistoryManagerContext | General context for the service calls containing information like history. |
callbackHandle | Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context. |
pContinuationPoint | The continuation point data from a previous Read call. Null if first Read. Implementers of this interface can store the continuation point data in a derived class. |
IsReadModified | true if modified false if not. |
numValuesPerNode | the Number of Values per Node. |
startTime | The start time of the time period to read. |
endTime | The end time of the time period to read. |
returnBounds | Flag that indicates if bounding values should be returned. |
Implemented in HistoryManagerBase.
|
pure virtual |
Update history values for a node.
hHistoryManagerContext | General context for the service calls containing information like history. |
callbackHandle | Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context. |
performInsertReplace | The mode to insert data or to replace older data. |
updateValue | The list of data values to update. |
Implemented in HistoryManagerBase.
|
pure virtual |
Update history event for a node.
hHistoryManagerContext | General context for the service calls containing information like history. |
callbackHandle | Handle for the node in the callback. This handle was passed in to the IOManager with the beginStopMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. This object contains the information needed by the IOManager to identify the node to read in its context. |
performInsertReplace | The mode to insert events or to replace older events. |
filter | An event filter used to select events to update. |
eventData | A list of events to update. |
Implemented in HistoryManagerBase.
|
pure virtual |
Finish a transaction.
hHistoryManagerContext | General context for the service calls containing information like history. |
Implemented in HistoryManagerBase.