sopc_address_space_utils_internal.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 SOPC_ADDRESS_SPACE_UTILS_INTERNAL_H_
#define SOPC_ADDRESS_SPACE_UTILS_INTERNAL_H_
 
#include <stdbool.h>
 
#include "sopc_address_space.h"
#include "sopc_builtintypes.h"
#include "sopc_common_constants.h"
#include "sopc_types.h"
 
#define RECURSION_LIMIT SOPC_DEFAULT_MAX_STRUCT_NESTED_LEVEL
 
bool SOPC_AddressSpaceUtil_IsTypeDefinition(const OpcUa_ReferenceNode* ref);
bool SOPC_AddressSpaceUtil_IsComponent(const OpcUa_ReferenceNode* ref);
bool SOPC_AddressSpaceUtil_IsProperty(const OpcUa_ReferenceNode* ref);
bool SOPC_AddressSpaceUtil_IsHasSubtype(const OpcUa_ReferenceNode* ref, bool isReverse);
 
SOPC_ExpandedNodeId* SOPC_AddressSpaceUtil_GetTypeDefinition(SOPC_AddressSpace* addSpace, SOPC_AddressSpace_Node* node);
 
// Static resolution from NodeId using known types + dynamic using Node references if not found
const SOPC_NodeId* SOPC_AddressSpaceUtil_GetDirectParentType(SOPC_AddressSpace* addSpace,
                                                             const SOPC_NodeId* childNodeId);
 
// Dynamic resolution from Node using references
const SOPC_NodeId* SOPC_AddressSpaceUtil_GetDirectParentTypeOfNode(SOPC_AddressSpace* addSpace,
                                                                   SOPC_AddressSpace_Node* child);
 
bool SOPC_AddressSpaceUtil_RecursiveIsTransitiveSubtype(SOPC_AddressSpace* addSpace,
                                                        int recursionLimit,
                                                        const SOPC_NodeId* originSubtype,
                                                        const SOPC_NodeId* currentTypeOrSubtype,
                                                        const SOPC_NodeId* expectedParentType);
 
bool SOPC_AddressSpaceUtil_IsValidReferenceTypeId(SOPC_AddressSpace* addSpace, const SOPC_NodeId* nodeId);
 
const SOPC_NodeId* SOPC_AddressSpaceUtil_GetEncodingDataType(SOPC_AddressSpace* addSpace,
                                                             const SOPC_NodeId* encodingNodeId);
 
const SOPC_NodeId* SOPC_AddressSpaceUtil_GetDataTypeDefaultBinaryEncoding(SOPC_AddressSpace* addSpace,
                                                                          const SOPC_NodeId* dataTypeId);
 
#endif /* SOPC_ADDRESS_SPACE_UTILS_INTERNAL_H_ */