UA Server SDK C++ Bundle
1.3.2.200
|
HistoryManager base implementation providing a simplified synchronous API. More...
#include <historymanagerbase.h>
Inherits HistoryManager.
Public Member Functions | |
HistoryManagerBase () | |
construction | |
virtual | ~HistoryManagerBase () |
destruction | |
virtual UaStatus | readRaw (const ServiceContext &serviceContext, HistoryVariableHandle *pVariableHandle, HistoryReadCPUserDataBase **ppContinuationPoint, OpcUa_TimestampsToReturn timestampsToReturn, OpcUa_UInt32 maxValues, OpcUa_DateTime &startTime, OpcUa_DateTime &endTime, OpcUa_Boolean returnBounds, UaDataValues &dataValues)=0 |
Read raw history values for a node. | |
virtual UaStatus | readModified (const ServiceContext &serviceContext, HistoryVariableHandle *pVariableHandle, HistoryReadCPUserDataBase **ppContinuationPoint, OpcUa_TimestampsToReturn timestampsToReturn, OpcUa_UInt32 maxValues, OpcUa_DateTime &startTime, OpcUa_DateTime &endTime, OpcUa_Boolean returnBounds, UaDataValues &dataValues, UaModificationInfo &modificationInformations) |
Read modified history values for a node. | |
virtual UaStatus | readProcessed (const ServiceContext &serviceContext, HistoryVariableHandle *pVariableHandle, HistoryReadCPUserDataBase **ppContinuationPoint, OpcUa_TimestampsToReturn timestampsToReturn, OpcUa_DateTime &startTime, OpcUa_DateTime &endTime, OpcUa_Double resampleInterval, const UaNodeId &aggregateType, OpcUa_AggregateConfiguration aggregateConfiguration, UaDataValues &dataValues) |
Read processed history values for a node. | |
virtual UaStatus | readAtTime (const ServiceContext &serviceContext, HistoryVariableHandle *pVariableHandle, OpcUa_TimestampsToReturn timestampsToReturn, const UaDateTimeArray &requestedTimes, UaDataValues &dataValues) |
Read history values for a node at specific timestamps. | |
virtual UaStatus | readEvents (const ServiceContext &serviceContext, HistoryVariableHandle *pVariableHandle, HistoryReadCPUserDataBase **ppContinuationPoint, OpcUa_TimestampsToReturn timestampsToReturn, OpcUa_UInt32 numValuesPerNode, OpcUa_DateTime &startTime, OpcUa_DateTime &endTime, const OpcUa_EventFilter &filter, UaHistoryEventFieldLists &events) |
Read event history for a node. | |
virtual UaStatus | updateData (const ServiceContext &serviceContext, HistoryVariableHandle *pVariableHandle, OpcUa_PerformUpdateType performInsertReplace, const UaDataValues &updateValue, UaStatusCodeArray &operationResults, UaDiagnosticInfos &operationDiagnosticInfos) |
Update history values for a node. | |
virtual UaStatus | updateEvents (const ServiceContext &serviceContext, HistoryVariableHandle *pVariableHandle, OpcUa_PerformUpdateType performInsertReplace, const OpcUa_EventFilter &filter, const UaEventFieldLists &eventData, UaStatusCodeArray &operationResults, UaDiagnosticInfos &operationDiagnosticInfos) |
Update history events for a node. | |
virtual UaStatus | deleteRawModified (const ServiceContext &serviceContext, HistoryVariableHandle *pVariableHandle, OpcUa_Boolean isDeleteModified, OpcUa_DateTime &startTime, OpcUa_DateTime &endTime) |
Delete raw or modified history values for a node. | |
virtual UaStatus | deleteAtTime (const ServiceContext &serviceContext, HistoryVariableHandle *pVariableHandle, const UaDateTimeArray &requestedTimes, UaStatusCodeArray &operationResults, UaDiagnosticInfos &operationDiagnosticInfos) |
Delete history values at the passed timestamps. | |
virtual UaStatus | deleteEvents (const ServiceContext &serviceContext, HistoryVariableHandle *pVariableHandle, const UaByteStringArray &eventIds, UaStatusCodeArray &operationResults, UaDiagnosticInfos &operationDiagnosticInfos) |
Delete events for a node. | |
UaStatus | beginHistoryTransaction (HistoryManagerCallback *, const ServiceContext &, OpcUa_UInt32, HistoryManager::TransactionType, OpcUa_TimestampsToReturn, OpcUa_Handle &) |
Start a transaction. | |
UaStatus | beginReadRawModified (OpcUa_Handle, OpcUa_UInt32, HistoryVariableHandle *, HistoryReadCPUserDataBase *, OpcUa_Boolean, OpcUa_UInt32, OpcUa_DateTime &, OpcUa_DateTime &, OpcUa_Boolean) |
Read raw or modified history values for a node. | |
UaStatus | beginReadProcessed (OpcUa_Handle, OpcUa_UInt32, HistoryVariableHandle *, HistoryReadCPUserDataBase *, OpcUa_DateTime &, OpcUa_DateTime &, OpcUa_Double, const OpcUa_NodeId &, OpcUa_AggregateConfiguration) |
Read processed history values for a node. | |
UaStatus | beginReadAtTime (OpcUa_Handle, OpcUa_UInt32, HistoryVariableHandle *, HistoryReadCPUserDataBase *, const UaDateTimeArray &) |
Read history values for a node at specific timestamps. | |
UaStatus | beginReadEvents (OpcUa_Handle, OpcUa_UInt32, HistoryVariableHandle *, HistoryReadCPUserDataBase *, OpcUa_UInt32, OpcUa_DateTime &, OpcUa_DateTime &, const OpcUa_EventFilter &) |
Read event history for a node. | |
UaStatus | beginUpdateData (OpcUa_Handle, OpcUa_UInt32, HistoryVariableHandle *, OpcUa_PerformUpdateType, const UaDataValues &) |
Update history values for a node. | |
UaStatus | beginUpdateEvents (OpcUa_Handle, OpcUa_UInt32, HistoryVariableHandle *, OpcUa_PerformUpdateType, const OpcUa_EventFilter &, const UaEventFieldLists &) |
Update history event for a node. | |
UaStatus | beginDeleteRawModified (OpcUa_Handle, OpcUa_UInt32, HistoryVariableHandle *, OpcUa_Boolean, OpcUa_DateTime &, OpcUa_DateTime &) |
Delete raw or modified history values for a node. | |
UaStatus | beginDeleteAtTime (OpcUa_Handle, OpcUa_UInt32, HistoryVariableHandle *, const UaDateTimeArray &) |
Delete raw or modified history values for a node. | |
UaStatus | beginDeleteEvents (OpcUa_Handle, OpcUa_UInt32, HistoryVariableHandle *, const UaByteStringArray &) |
Delete events for a node. | |
UaStatus | finishHistoryTransaction (OpcUa_Handle) |
Finish a transaction. | |
Public Member Functions inherited from HistoryManager | |
HistoryManager () | |
construction | |
virtual | ~HistoryManager () |
destruction |
Additional Inherited Members | |
Public Types inherited from HistoryManager | |
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... |
HistoryManager base implementation providing a simplified synchronous API.
This class simplifies the HistoryManager interface implementation by changing the interface to a single node based synchronous API and by providing a default implementation for most of the function, either returning an error BadHistoryOperationUnsupported or by providing an implementation like for read processed. The only required method to implement in the derived class is the readRawModified method. Other methods can be implemented if the functionality should be provided by the server.
|
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 beginStartMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
requestedTimes | the requested time when to begin to read. |
Implements HistoryManager.
|
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 beginStartMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
eventIds | the Id of the currently fired Event. |
Implements HistoryManager.
|
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 beginStartMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
isDeleteModified | a variable that indicates if the new values is modified or not. |
startTime | a value when to start processing. |
endTime | a value when to stop processing. |
Implements HistoryManager.
|
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. |
hHistoryManagerContext | General context for the service calls containing information like history. |
timestampsToReturn | The client selected timestamp to return. Valid enum values are: OpcUa_TimestampsToReturn_Source, OpcUa_TimestampsToReturn_Server, OpcUa_TimestampsToReturn_Both |
Implements HistoryManager.
|
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 beginStartMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
requestedTimes | the requested time when to begin to read. |
pContinuationPoint | The continuation point data if not all results can be returned in one Read call. Implementers of this interface can store the continuation point data in a derived class. |
Implements HistoryManager.
|
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 beginStartMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
numValuesPerNode | the Number of Values per Node. |
startTime | a value when to start processing. |
pContinuationPoint | The continuation point data if not all results can be returned in one Read call. Implementers of this interface can store the continuation point data in a derived class. |
endTime | a value when to stop processing. |
filter | a filter for all common Events that can occur. |
Implements HistoryManager.
|
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 beginStartMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
pContinuationPoint | The continuation point data if not all results can be returned in one Read call. Implementers of this interface can store the continuation point data in a derived class. |
startTime | a value when to start processing. |
endTime | a value when to stop processing. |
resampleInterval | the interval to re sample. |
aggregateType | the aggregate type of the node. |
aggregateConfiguration | The aggregate configuration. |
Implements HistoryManager.
|
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 beginStartMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
pContinuationPoint | The continuation point data if not all results can be returned in one Read call. Implementers of this interface can store the continuation point data in a derived class. |
bIsReadModified | true if modified false if not |
numValuesPerNode | the Number of Values per Node. |
startTime | a value when to start processing. |
endTime | a value when to stop processing. |
returnBounds | the returned bounds of the actual operation. |
Implements HistoryManager.
|
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 beginStartMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
performInsertReplace | a mode to insert data by replacing the older data. |
updateValue | a variable to fill with data to update. |
Implements HistoryManager.
|
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 beginStartMonitoring method. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
performInsertReplace | a mode to insert data by replacing the older data. |
filter | a filter for all common Events that can occur. |
eventData | a field list of event data. |
Implements HistoryManager.
|
virtual |
Delete history values at the passed timestamps.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
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. |
operationResults | The results for the requested timestamps to delete. |
operationDiagnosticInfos | The diagnostic for the requested timestamps to delete. |
|
virtual |
Delete events for a node.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
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. |
operationResults | The results for the requested events to delete. |
operationDiagnosticInfos | The diagnostic for the requested events to delete. |
|
virtual |
Delete raw or modified history values for a node.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
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. |
|
virtual |
Finish a transaction.
hHistoryManagerContext | General context for the service calls containing information like history. |
Implements HistoryManager.
|
virtual |
Read history values for a node at specific timestamps.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
timestampsToReturn | The client selected timestamp to return. Valid enum values are: OpcUa_TimestampsToReturn_Source, OpcUa_TimestampsToReturn_Server, OpcUa_TimestampsToReturn_Both |
requestedTimes | The requested timestamps to read. |
dataValues | The requested values for this operation. |
|
virtual |
Read event history for a node.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
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. |
ppContinuationPoint | 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. |
timestampsToReturn | The client selected timestamp to return. Valid enum values are: OpcUa_TimestampsToReturn_Source, OpcUa_TimestampsToReturn_Server, OpcUa_TimestampsToReturn_Both |
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. |
events | A list of events that match the read filter. |
|
virtual |
Read modified history values for a node.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
pVariableHandle | Variable handle provided by the NodeManager::getHistoryVariableHandle. |
ppContinuationPoint | 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. |
timestampsToReturn | The client selected timestamp to return. Valid enum values are: OpcUa_TimestampsToReturn_Source, OpcUa_TimestampsToReturn_Server, OpcUa_TimestampsToReturn_Both |
maxValues | The maximum number of values to return. |
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. |
dataValues | The requested values for this operation. |
modificationInformations | The modification information for the requested Values for this operation. The information array will be detached by the SDK. |
|
virtual |
Read processed history values for a node.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
pVariableHandle | Variable handle provided by the NodeManager::getVariableHandle. |
ppContinuationPoint | 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. |
timestampsToReturn | The client selected timestamp to return. Valid enum values are: OpcUa_TimestampsToReturn_Source, OpcUa_TimestampsToReturn_Server, OpcUa_TimestampsToReturn_Both |
startTime | The start time of the time period to read. |
endTime | The end time of the time period to read. |
resampleInterval | The interval to re sample. |
aggregateType | The aggregate type node id. |
aggregateConfiguration | The aggregate configuration. |
dataValues | The requested values for this operation. |
|
pure virtual |
Read raw history values for a node.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
pVariableHandle | Variable handle provided by the NodeManager::getHistoryVariableHandle. |
ppContinuationPoint | 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. |
timestampsToReturn | The client selected timestamp to return. Valid enum values are: OpcUa_TimestampsToReturn_Source, OpcUa_TimestampsToReturn_Server, OpcUa_TimestampsToReturn_Both |
maxValues | The maximum number of values to return. |
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. |
dataValues | The requested values for this operation. |
|
virtual |
Update history values for a node.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
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. |
operationResults | The results for the requested update values. |
operationDiagnosticInfos | The diagnostic for the requested update values. |
|
virtual |
Update history events for a node.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
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. |
operationResults | The results for the requested update events. |
operationDiagnosticInfos | The diagnsotic for the requested update events. |