S2OPC OPCUA Toolkit
sopc_address_space_access.h
Go to the documentation of this file.
1 /*
2  * Licensed to Systerel under one or more contributor license
3  * agreements. See the NOTICE file distributed with this work
4  * for additional information regarding copyright ownership.
5  * Systerel licenses this file to you under the Apache
6  * License, Version 2.0 (the "License"); you may not use this
7  * file except in compliance with the License. You may obtain
8  * a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 
20 #ifndef SOPC_ADDRESS_SPACE_ACCESS_H_
21 #define SOPC_ADDRESS_SPACE_ACCESS_H_
22 
23 #include <stdbool.h>
24 
25 #include "sopc_builtintypes.h"
26 #include "sopc_types.h"
27 
40 typedef struct _SOPC_AddressSpaceAccess SOPC_AddressSpaceAccess;
41 
69  const SOPC_NodeId* nodeId,
70  SOPC_AttributeId attribId,
71  SOPC_Variant** outValue);
72 
94  const SOPC_NodeId* nodeId,
95  const SOPC_NumericRange* optNumRange,
96  SOPC_DataValue** outDataValue);
97 
130  const SOPC_NodeId* nodeId,
131  const SOPC_NumericRange* optNumRange,
132  const SOPC_Variant* value,
133  const SOPC_StatusCode* optStatus,
134  const SOPC_DateTime* optSourceTimestamp,
135  const uint16_t* optSourcePicoSeconds);
136 
193  const SOPC_ExpandedNodeId* parentNodeId,
194  const SOPC_NodeId* refTypeId,
195  const SOPC_NodeId* newNodeId,
196  const SOPC_QualifiedName* browseName,
197  const OpcUa_VariableAttributes* varAttributes,
198  const SOPC_ExpandedNodeId* typeDefId);
199 
200 #endif /* SOPC_ADDRESS_SPACE_ACCESS_H_ */
SOPC_NodeId
This structure describes a basic NodeID in OPC UA.
Definition: sopc_builtintypes.h:189
sopc_types.h
SOPC_StatusCode
uint32_t SOPC_StatusCode
Definition: libs2opc_client.h:60
_OpcUa_VariableAttributes
Definition: sopc_types.h:3135
SOPC_ExpandedNodeId
ExpandedNodeId allows the namespace to be specified explicitly as a string or with an index in the Se...
Definition: sopc_builtintypes.h:207
sopc_builtintypes.h
SOPC_AttributeId
SOPC_AttributeId
Enumerated for all possible OPC UA attribute ids.
Definition: sopc_builtintypes.h:71
SOPC_AddressSpaceAccess_ReadValue
SOPC_StatusCode SOPC_AddressSpaceAccess_ReadValue(const SOPC_AddressSpaceAccess *addSpaceAccess, const SOPC_NodeId *nodeId, const SOPC_NumericRange *optNumRange, SOPC_DataValue **outDataValue)
Read Value attribute content with Status and Source Timestamp metadata.
SOPC_AddressSpaceAccess
struct _SOPC_AddressSpaceAccess SOPC_AddressSpaceAccess
AddressSpace Access module provides controlled access to address space. This might be used to access ...
Definition: sopc_address_space_access.h:40
SOPC_Variant
This structure provides variant encapsulation.
Definition: sopc_builtintypes.h:374
SOPC_DateTime
int64_t SOPC_DateTime
OPC UA timestamp format which is 100 nanoseconds from 1601/01/01 00:00:00 UTC.
Definition: sopc_builtintypes.h:160
SOPC_AddressSpaceAccess_ReadAttribute
SOPC_StatusCode SOPC_AddressSpaceAccess_ReadAttribute(const SOPC_AddressSpaceAccess *addSpaceAccess, const SOPC_NodeId *nodeId, SOPC_AttributeId attribId, SOPC_Variant **outValue)
Read an attribute and retrieve its value as a Variant.
SOPC_DataValue
Each attribute in OPC UA has a DataValue caracterized by the following structure.
Definition: sopc_builtintypes.h:385
SOPC_AddressSpaceAccess_AddVariableNode
SOPC_StatusCode SOPC_AddressSpaceAccess_AddVariableNode(SOPC_AddressSpaceAccess *addSpaceAccess, const SOPC_ExpandedNodeId *parentNodeId, const SOPC_NodeId *refTypeId, const SOPC_NodeId *newNodeId, const SOPC_QualifiedName *browseName, const OpcUa_VariableAttributes *varAttributes, const SOPC_ExpandedNodeId *typeDefId)
Add a Variable node into the AddressSpace with given attributes and references to its parent and type...
SOPC_QualifiedName
Definition: sopc_builtintypes.h:228
_SOPC_NumericRange
Definition: sopc_numeric_range.h:35
SOPC_AddressSpaceAccess_WriteValue
SOPC_StatusCode SOPC_AddressSpaceAccess_WriteValue(SOPC_AddressSpaceAccess *addSpaceAccess, const SOPC_NodeId *nodeId, const SOPC_NumericRange *optNumRange, const SOPC_Variant *value, const SOPC_StatusCode *optStatus, const SOPC_DateTime *optSourceTimestamp, const uint16_t *optSourcePicoSeconds)
Write Value attribute content with Status and Source Timestamp metadata.