libs2opc_request_builder.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef LIBS2OPC_REQUEST_BUILDER_H_
#define LIBS2OPC_REQUEST_BUILDER_H_
 
#include "sopc_types.h"
 
OpcUa_ReadRequest* SOPC_ReadRequest_Create(size_t nbReadValues, OpcUa_TimestampsToReturn tsToReturn);
 
SOPC_ReturnStatus SOPC_ReadRequest_SetMaxAge(OpcUa_ReadRequest* readRequest, double maxAge);
 
SOPC_ReturnStatus SOPC_ReadRequest_SetReadValueFromStrings(OpcUa_ReadRequest* readRequest,
                                                           size_t index,
                                                           const char* nodeId,
                                                           SOPC_AttributeId attribute,
                                                           const char* indexRange);
 
SOPC_ReturnStatus SOPC_ReadRequest_SetReadValue(OpcUa_ReadRequest* readRequest,
                                                size_t index,
                                                const SOPC_NodeId* nodeId,
                                                SOPC_AttributeId attribute,
                                                const SOPC_String* indexRange);
 
SOPC_ReturnStatus SOPC_ReadRequest_SetReadValueDataEncoding(OpcUa_ReadRequest* readRequest,
                                                            size_t index,
                                                            const SOPC_QualifiedName* dataEncoding);
 
OpcUa_WriteRequest* SOPC_WriteRequest_Create(size_t nbWriteValues);
 
SOPC_ReturnStatus SOPC_WriteRequest_SetWriteValueFromStrings(OpcUa_WriteRequest* writeRequest,
                                                             size_t index,
                                                             const char* nodeId,
                                                             SOPC_AttributeId attribute,
                                                             const char* indexRange,
                                                             const SOPC_DataValue* value);
 
SOPC_ReturnStatus SOPC_WriteRequest_SetWriteValue(OpcUa_WriteRequest* writeRequest,
                                                  size_t index,
                                                  const SOPC_NodeId* nodeId,
                                                  SOPC_AttributeId attribute,
                                                  const SOPC_String* indexRange,
                                                  const SOPC_DataValue* value);
 
OpcUa_BrowseRequest* SOPC_BrowseRequest_Create(size_t nbNodesToBrowse,
                                               size_t maxReferencesPerNode,
                                               const OpcUa_ViewDescription* optView);
 
SOPC_ReturnStatus SOPC_BrowseRequest_SetBrowseDescriptionFromStrings(OpcUa_BrowseRequest* browseRequest,
                                                                     size_t index,
                                                                     const char* nodeId,
                                                                     OpcUa_BrowseDirection browseDirection,
                                                                     const char* referenceTypeId,
                                                                     bool includeSubtypes,
                                                                     OpcUa_NodeClass nodeClassMask,
                                                                     OpcUa_BrowseResultMask resultMask);
 
SOPC_ReturnStatus SOPC_BrowseRequest_SetBrowseDescription(OpcUa_BrowseRequest* browseRequest,
                                                          size_t index,
                                                          const SOPC_NodeId* nodeId,
                                                          OpcUa_BrowseDirection browseDirection,
                                                          const SOPC_NodeId* referenceTypeId,
                                                          bool includeSubtypes,
                                                          OpcUa_NodeClass nodeClassMask,
                                                          OpcUa_BrowseResultMask resultMask);
 
OpcUa_BrowseNextRequest* SOPC_BrowseNextRequest_Create(bool releaseContinuationPoints, size_t nbContinuationPoints);
 
OpcUa_TranslateBrowsePathsToNodeIdsRequest* SOPC_TranslateBrowsePathsRequest_Create(size_t nbTranslateBrowsePaths);
 
SOPC_ReturnStatus SOPC_TranslateBrowsePathRequest_SetPathFromString(
    OpcUa_TranslateBrowsePathsToNodeIdsRequest* tbpRequest,
    size_t index,
    const char* startingNodeId,
    size_t nbPathElements,
    OpcUa_RelativePathElement* pathElements);
 
SOPC_ReturnStatus SOPC_TranslateBrowsePathRequest_SetPath(OpcUa_TranslateBrowsePathsToNodeIdsRequest* tbpRequest,
                                                          size_t index,
                                                          SOPC_NodeId* startingNodeId,
                                                          size_t nbPathElements,
                                                          OpcUa_RelativePathElement* pathElements);
 
OpcUa_RelativePathElement* SOPC_RelativePathElements_Create(size_t nbPathElements);
 
SOPC_ReturnStatus SOPC_RelativePathElements_SetPathElement(OpcUa_RelativePathElement* pathElementsArray,
                                                           size_t index,
                                                           const SOPC_NodeId* referenceTypeId,
                                                           bool isInverse,
                                                           bool includeSubtypes,
                                                           uint16_t targetNsIndex,
                                                           const char* targetName);
 
SOPC_ReturnStatus SOPC_BrowseNextRequest_SetContinuationPoint(OpcUa_BrowseNextRequest* browseNextRequest,
                                                              size_t index,
                                                              const SOPC_ByteString* continuationPoint);
 
OpcUa_GetEndpointsRequest* SOPC_GetEndpointsRequest_Create(const char* endpointURL);
 
SOPC_ReturnStatus SOPC_GetEndpointsRequest_SetPreferredLocales(OpcUa_GetEndpointsRequest* getEndpointsReq,
                                                               size_t nbLocales,
                                                               char* const* localeIds);
 
SOPC_ReturnStatus SOPC_GetEndpointsRequest_SetProfileURIs(OpcUa_GetEndpointsRequest* getEndpointsReq,
                                                          size_t nbProfiles,
                                                          char* const* profileURIs);
 
OpcUa_RegisterServer2Request* SOPC_RegisterServer2Request_CreateFromServerConfiguration(void);
 
OpcUa_AddNodesRequest* SOPC_AddNodesRequest_Create(size_t nbAddNodes);
 
SOPC_ReturnStatus SOPC_AddNodeRequest_SetVariableAttributes(OpcUa_AddNodesRequest* addNodesRequest,
                                                            size_t index,
                                                            const SOPC_ExpandedNodeId* parentNodeId,
                                                            const SOPC_NodeId* referenceTypeId,
                                                            const SOPC_ExpandedNodeId* optRequestedNodeId,
                                                            const SOPC_QualifiedName* browseName,
                                                            const SOPC_ExpandedNodeId* typeDefinition,
                                                            const SOPC_LocalizedText* optDisplayName,
                                                            const SOPC_LocalizedText* optDescription,
                                                            const uint32_t* optWriteMask,
                                                            const uint32_t* optUserWriteMask,
                                                            const SOPC_Variant* optValue,
                                                            const SOPC_NodeId* optDataType,
                                                            const int32_t* optValueRank,
                                                            int32_t noOfArrayDimensions,
                                                            const uint32_t* optArrayDimensions,
                                                            const SOPC_Byte* optAccessLevel,
                                                            const SOPC_Byte* optUserAccessLevel,
                                                            const double* optMinimumSamplingInterval,
                                                            SOPC_Boolean* optHistorizing);
 
SOPC_ReturnStatus SOPC_AddNodeRequest_SetObjectAttributes(OpcUa_AddNodesRequest* addNodesRequest,
                                                          size_t index,
                                                          const SOPC_ExpandedNodeId* parentNodeId,
                                                          const SOPC_NodeId* referenceTypeId,
                                                          const SOPC_ExpandedNodeId* optRequestedNodeId,
                                                          const SOPC_QualifiedName* browseName,
                                                          const SOPC_ExpandedNodeId* typeDefinition,
                                                          const SOPC_LocalizedText* optDisplayName,
                                                          const SOPC_LocalizedText* optDescription,
                                                          const uint32_t* optWriteMask,
                                                          const uint32_t* optUserWriteMask,
                                                          const SOPC_Byte* eventNotifier);
OpcUa_CreateSubscriptionRequest* SOPC_CreateSubscriptionRequest_CreateDefault(void);
 
OpcUa_CreateSubscriptionRequest* SOPC_CreateSubscriptionRequest_Create(double reqPublishingInterval,
                                                                       uint32_t reqLifetimeCount,
                                                                       uint32_t reqMaxKeepAliveCount,
                                                                       uint32_t maxNotifPerPublish,
                                                                       SOPC_Boolean publishingEnabled,
                                                                       SOPC_Byte priority);
 
OpcUa_CreateMonitoredItemsRequest* SOPC_CreateMonitoredItemsRequest_CreateDefault(const uint32_t subscriptionId,
                                                                                  size_t nbMonitoredItems,
                                                                                  const SOPC_NodeId* nodeIdsToMonitor,
                                                                                  OpcUa_TimestampsToReturn ts);
 
OpcUa_CreateMonitoredItemsRequest* SOPC_CreateMonitoredItemsRequest_CreateDefaultFromStrings(
    uint32_t subscriptionId,
    size_t nbMonitoredItems,
    char* const* nodeIdsToMonitor,
    OpcUa_TimestampsToReturn ts);
 
OpcUa_CreateMonitoredItemsRequest* SOPC_CreateMonitoredItemsRequest_Create(uint32_t subscriptionId,
                                                                           size_t nbMonitoredItems,
                                                                           OpcUa_TimestampsToReturn ts);
 
SOPC_ReturnStatus SOPC_CreateMonitoredItemsRequest_SetMonitoredItemId(
    OpcUa_CreateMonitoredItemsRequest* createMIrequest,
    size_t index,
    const SOPC_NodeId* nodeId,
    SOPC_AttributeId attribute,
    const SOPC_String* indexRange);
 
SOPC_ReturnStatus SOPC_CreateMonitoredItemsRequest_SetMonitoredItemIdFromStrings(
    OpcUa_CreateMonitoredItemsRequest* createMIrequest,
    size_t index,
    const char* nodeId,
    SOPC_AttributeId attribute,
    const char* indexRange);
 
SOPC_ExtensionObject* SOPC_MonitoredItem_DataChangeFilter(OpcUa_DataChangeTrigger trigger,
                                                          OpcUa_DeadbandType deadbandType,
                                                          double deadbandValue);
 
OpcUa_EventFilter* SOPC_MonitoredItem_CreateEventFilter(size_t noOfSelectClauses, size_t noOfWhereClauseElt);
 
SOPC_ReturnStatus SOPC_EventFilter_SetOfTypeWhereClause(OpcUa_EventFilter* eventFilter,
                                                        size_t whereClauseEltIdx,
                                                        const SOPC_NodeId* typeNodeId);
 
SOPC_ReturnStatus SOPC_EventFilter_SetGenericWhereClause(OpcUa_EventFilter* eventFilter,
                                                         size_t whereClauseEltIdx,
                                                         OpcUa_ContentFilterElement** filterElt);
 
SOPC_ReturnStatus SOPC_EventFilter_SetSelectClause(OpcUa_EventFilter* eventFilter,
                                                   size_t selectClauseIdx,
                                                   const SOPC_NodeId* typeId,
                                                   size_t noOfBrowsePath,
                                                   const SOPC_QualifiedName* browsePaths,
                                                   SOPC_AttributeId attributeId,
                                                   const SOPC_String* indexRange);
 
SOPC_ReturnStatus SOPC_EventFilter_SetSelectClauseFromStringPath(OpcUa_EventFilter* eventFilter,
                                                                 size_t selectClauseIdx,
                                                                 const char* typeId,
                                                                 char qnPathSep,
                                                                 const char* strQnPath,
                                                                 SOPC_AttributeId attributeId,
                                                                 const char* indexRange);
 
SOPC_ExtensionObject* SOPC_MonitoredItem_EventFilter(OpcUa_EventFilter* eventFilterObj);
 
SOPC_ReturnStatus SOPC_CreateMonitoredItemsRequest_SetMonitoredItemParams(
    OpcUa_CreateMonitoredItemsRequest* createMIrequest,
    size_t index,
    OpcUa_MonitoringMode monitoringMode,
    uint32_t clientHandle,
    double samplingInterval,
    SOPC_ExtensionObject* optFilter,
    uint32_t queueSize,
    SOPC_Boolean discardOldest);
 
OpcUa_ModifyMonitoredItemsRequest* SOPC_ModifyMonitoredItemsRequest_Create(uint32_t subscriptionId,
                                                                           size_t nbMonitoredItems,
                                                                           OpcUa_TimestampsToReturn ts);
 
SOPC_ReturnStatus SOPC_ModifyMonitoredItemsRequest_SetMonitoredItemParams(
    OpcUa_ModifyMonitoredItemsRequest* modifyMIrequest,
    size_t index,
    uint32_t monitoredItemId,
    uint32_t clientHandle,
    double samplingInterval,
    SOPC_ExtensionObject* optFilter,
    uint32_t queueSize,
    SOPC_Boolean discardOldest);
 
OpcUa_DeleteMonitoredItemsRequest* SOPC_DeleteMonitoredItemsRequest_Create(uint32_t subscriptionId,
                                                                           size_t nbMonitoredItems,
                                                                           const uint32_t* optMonitoredItemIds);
 
SOPC_ReturnStatus SOPC_DeleteMonitoredItemsRequest_SetMonitoredItemId(
    OpcUa_DeleteMonitoredItemsRequest* deleteMIrequest,
    size_t index,
    uint32_t monitoredItemId);
 
OpcUa_CallRequest* SOPC_CallRequest_Create(size_t nbMethodsToCalls);
 
SOPC_ReturnStatus SOPC_CallRequest_SetMethodToCall(OpcUa_CallRequest* callRequest,
                                                   size_t index,
                                                   const SOPC_NodeId* objectId,
                                                   const SOPC_NodeId* methodId,
                                                   int32_t nbOfInputArguments,
                                                   const SOPC_Variant* inputArguments);
 
SOPC_ReturnStatus SOPC_CallRequest_SetMethodToCallFromStrings(OpcUa_CallRequest* callRequest,
                                                              size_t index,
                                                              const char* objectId,
                                                              const char* methodId,
                                                              int32_t nbOfInputArguments,
                                                              const SOPC_Variant* inputArguments);
 
#endif /* LIBS2OPC_REQUEST_BUILDER_H_ */