Data Structures
struct	OpcUa_Reference
	Represents a reference from one node to another. More...

union	OpcUa_Reference::OpcUa_Reference_Target
	Holds the target of the reference, depending on targetType the according member is set. More...

Typedefs
typedef enum _NodeTypes	OpcUa_NodeType
	An Enumeration of NodeTypes. More...

typedef enum _TargetType	TargetType
	Indicates if a OpcUa_Reference is pointing to a OpcUa_BaseNode or to a OpcUa_NodeId. More...

Enumerations
enum	_NodeTypes
	An Enumeration of NodeTypes. More...

enum	_TargetType { TargetTypeNode = 0, TargetTypeNodeId }
	Indicates if a OpcUa_Reference is pointing to a OpcUa_BaseNode or to a OpcUa_NodeId. More...

Functions
OpcUa_NodeId *	OpcUa_BaseNode_GetId (OpcUa_Void *pObj)
	OpcUa_BaseNode_GetId function implementation. More...

OpcUa_UInt32	OpcUa_BaseNode_GetWriteMask (OpcUa_Void *pObj)
	OpcUa_BaseNode_GetWriteMask function implementation. More...

OpcUa_Void *	OpcUa_BaseNode_GetUserData (OpcUa_Void *pObj)
	OpcUa_BaseNode_GetUserData function implementation. More...

OpcUa_QualifiedName *	OpcUa_BaseNode_GetBrowseName (OpcUa_Void *pObj)
	OpcUa_BaseNode_GetBrowseName function implementation. More...

OpcUa_LocalizedText *	OpcUa_BaseNode_GetDisplayName (OpcUa_Void *pObj)
	OpcUa_BaseNode_GetDisplayName function implementation. More...

OpcUa_LocalizedText *	OpcUa_BaseNode_GetDescription (OpcUa_Void *pObj)
	OpcUa_BaseNode_GetDescription function implementation. More...

OpcUa_Void	OpcUa_BaseNode_SetId (OpcUa_Void pObj, OpcUa_NodeId a_pId)
	OpcUa_BaseNode_SetId function implementation. More...

OpcUa_Void	OpcUa_BaseNode_SetId_Numeric (OpcUa_Void *pObj, OpcUa_UInt32 a_Id, OpcUa_UInt16 a_NamespaceIndex)
	OpcUa_BaseNode_SetId_Numeric function implementation. More...

OpcUa_Void	OpcUa_BaseNode_SetWriteMask (OpcUa_Void *pObj, OpcUa_UInt32 a_WriteMask)
	OpcUa_BaseNode_SetWriteMask function implementation. More...

OpcUa_Void	OpcUa_BaseNode_SetUserData (OpcUa_Void pObj, OpcUa_Void a_pUserData)
	OpcUa_BaseNode_SetUserData function implementation. More...

OpcUa_StatusCode	OpcUa_BaseNode_SetBrowseName (OpcUa_Void pObj, OpcUa_UInt16 NamespaceIndex, const OpcUa_CharA szName)
	OpcUa_BaseNode_SetBrowseName function implementation. More...

OpcUa_StatusCode	OpcUa_BaseNode_SetDisplayName (OpcUa_Void pObj, const OpcUa_CharA szLocale, const OpcUa_CharA *szName)
	OpcUa_BaseNode_SetDisplayName function implementation. More...

OpcUa_StatusCode	OpcUa_BaseNode_SetDescription (OpcUa_Void pObj, const OpcUa_CharA szLocale, const OpcUa_CharA *szName)
	OpcUa_BaseNode_SetDescription function implementation. More...

OpcUa_StatusCode	OpcUa_BaseNode_AttachBrowseName (OpcUa_Void pObj, OpcUa_QualifiedName pBrowseName)
	Attaches the given string to the nodes browse name. More...

OpcUa_StatusCode	OpcUa_BaseNode_AttachDisplayName (OpcUa_Void pObj, OpcUa_LocalizedText pDisplayName)
	OpcUa_BaseNode_AttachDisplayName function implementation. More...

OpcUa_StatusCode	OpcUa_BaseNode_AttachDescription (OpcUa_Void pObj, OpcUa_LocalizedText pDescription)
	OpcUa_BaseNode_AttachDescription function implementation. More...

OpcUa_Boolean	OpcUa_BaseNode_HasReferences (OpcUa_Void *pObj)
	OpcUa_BaseNode_HasReferences function implementation. More...

UaBase_Vector *	OpcUa_BaseNode_GetReferences (OpcUa_Void *pObj)
	OpcUa_BaseNode_GetReferences function implementation. More...

OpcUa_StatusCode	OpcUa_BaseNode_AddReference (OpcUa_Void pObj, OpcUa_Reference pReference)
	Add the given reference to a OpcUa_BaseNode. More...

OpcUa_StatusCode	OpcUa_BaseNode_AddReferenceToNode (OpcUa_Void pObj, OpcUa_BaseNode pNode, OpcUa_NodeId *pRefType, OpcUa_Boolean AddInverseReference)
	Add a reference pointing to another OpcUa_BaseNode. More...

OpcUa_StatusCode	OpcUa_BaseNode_AddReferenceToNodeId (OpcUa_Void pObj, OpcUa_NodeId pNodeId, OpcUa_NodeId *pRefType)
	Add a reference pointing to a OpcUa_NodeId. More...

OpcUa_StatusCode	OpcUa_BaseNode_RemoveReferences (OpcUa_Void *pObj)
	OpcUa_BaseNode_RemoveReferences function implementation. More...

OpcUa_StatusCode	OpcUa_BaseNode_RemoveReferenceToNode (OpcUa_Void pObj, OpcUa_BaseNode pNode, OpcUa_NodeId *pRefType, OpcUa_Boolean RemoveInverseReference)
	Removes a reference to a OpcUa_BaseNode (or subtype) from a OpcUa_BaseNode (or subtype) More...

OpcUa_StatusCode	OpcUa_BaseNode_RemoveReferenceToNodeId (OpcUa_Void pObj, OpcUa_NodeId pNodeId, OpcUa_NodeId *pRefType)
	Removes a reference to a NodeId from a OpcUa_BaseNode (or subtype) More...

UaServer_iNode *	OpcUa_BaseNode_GetINode (OpcUa_Void *pObj)
	OpcUa_BaseNode_GetINode function implementation. More...

OpcUa_Void	OpcUa_BaseNode_SetINode (OpcUa_Void pObj, UaServer_iNode a_pINode)
	OpcUa_BaseNode_SetINode function implementation. More...

OpcUa_DataType *	OpcUa_DataType_Create ()
	Create a new DataType. More...

OpcUa_Boolean	OpcUa_DataType_GetIsAbstract (OpcUa_Void *pObj)
	OpcUa_DataType_GetIsAbstract function implementation. More...

OpcUa_Void	OpcUa_DataType_SetIsAbstract (OpcUa_Void *pObj, OpcUa_Boolean a_IsAbstract)
	OpcUa_DataType_SetIsAbstract function implementation. More...

OpcUa_Method *	OpcUa_Method_Create ()
	Create a new Method. More...

OpcUa_Boolean	OpcUa_Method_GetExecutable (OpcUa_Void *pObj)
	OpcUa_Method_GetExecutable function implementation. More...

OpcUa_Boolean	OpcUa_Method_GetUserExecutable (OpcUa_Void *pObj)
	OpcUa_Method_GetUserExecutable function implementation. More...

OpcUa_Void	OpcUa_Method_SetExecutable (OpcUa_Void *pObj, OpcUa_Boolean a_Executable)
	OpcUa_Method_SetExecutable function implementation. More...

OpcUa_Void	OpcUa_Method_SetUserExecutable (OpcUa_Void *pObj, OpcUa_Boolean a_UserExecutable)
	OpcUa_Method_SetUserExecutable function implementation. More...

OpcUa_Object *	OpcUa_Object_Create ()
	Create a new Object. More...

OpcUa_Byte	OpcUa_Object_GetEventNotifier (OpcUa_Void *pObj)
	OpcUa_Object_GetEventNotifier function implementation. More...

OpcUa_Void	OpcUa_Object_SetEventNotifier (OpcUa_Void *pObj, OpcUa_Byte a_EventNotifier)
	OpcUa_Object_SetEventNotifier function implementation. More...

OpcUa_ObjectType *	OpcUa_ObjectType_Create ()
	Create a new ObjectType. More...

OpcUa_Boolean	OpcUa_ObjectType_GetIsAbstract (OpcUa_Void *pObj)
	OpcUa_ObjectType_GetIsAbstract function implementation. More...

OpcUa_Void	OpcUa_ObjectType_SetIsAbstract (OpcUa_Void *pObj, OpcUa_Boolean a_IsAbstract)
	OpcUa_ObjectType_SetIsAbstract function implementation. More...

OpcUa_ReferenceType *	OpcUa_ReferenceType_Create ()
	Create a new ReferenceType. More...

OpcUa_Boolean	OpcUa_ReferenceType_GetIsAbstract (OpcUa_Void *pObj)
	OpcUa_ReferenceType_GetIsAbstract function implementation. More...

OpcUa_Boolean	OpcUa_ReferenceType_GetSymmetric (OpcUa_Void *pObj)
	OpcUa_ReferenceType_GetSymmetric function implementation. More...

OpcUa_LocalizedText *	OpcUa_ReferenceType_GetInverseName (OpcUa_Void *pObj)
	OpcUa_ReferenceType_GetInverseName function implementation. More...

OpcUa_StatusCode	OpcUa_ReferenceType_AttachInverseName (OpcUa_Void pObj, OpcUa_LocalizedText a_pInverseName)
	OpcUa_ReferenceType_AttachInverseName function implementation. More...

OpcUa_Void	OpcUa_ReferenceType_SetIsAbstract (OpcUa_Void *pObj, OpcUa_Boolean a_IsAbstract)
	OpcUa_ReferenceType_SetIsAbstract function implementation. More...

OpcUa_Void	OpcUa_ReferenceType_SetSymmetric (OpcUa_Void *pObj, OpcUa_Boolean a_Symmetric)
	OpcUa_ReferenceType_SetSymmetric function implementation. More...

OpcUa_StatusCode	OpcUa_ReferenceType_SetInverseName (OpcUa_Void pObj, const OpcUa_CharA szLocale, const OpcUa_CharA *szInverseName)
	OpcUa_ReferenceType_SetInverseName function implementation. More...

OpcUa_Variable *	OpcUa_Variable_Create ()
	Create a new Variable. More...

OpcUa_Int32	OpcUa_Variable_GetValueRank (OpcUa_Void *pObj)
	OpcUa_Variable_GetValueRank function implementation. More...

OpcUa_Int32	OpcUa_Variable_GetNumArrayDimensions (OpcUa_Void *pObj)
	OpcUa_Variable_GetNumArrayDimensions function implementation. More...

OpcUa_UInt32 *	OpcUa_Variable_GetArrayDimensions (OpcUa_Void *pObj)
	OpcUa_Variable_GetArrayDimensions function implementation. More...

OpcUa_Void	OpcUa_Variable_SetValue (OpcUa_Void pObj, OpcUa_Variant pValue)
	OpcUa_Variable_SetValue function implementation. More...

OpcUa_Variant *	OpcUa_Variable_GetValue (OpcUa_Void *pObj)
	OpcUa_GetVariable_Value function implementation. More...

OpcUa_StatusCode	OpcUa_Variable_AttachValue (OpcUa_Void pObj, OpcUa_Variant pValue)
	OpcUa_Variable_AttachValue function implementation. More...

OpcUa_Void	OpcUa_Variable_SetDataType (OpcUa_Void pObj, OpcUa_NodeId a_pDataType)
	Set the data type attribute of an OpcUa_Variable. More...

OpcUa_Void	OpcUa_Variable_SetDataType_Numeric (OpcUa_Void *pObj, OpcUa_UInt32 a_Id, OpcUa_UInt16 a_NamespaceIndex)
	Set the data type attribute of an OpcUa_Variable. More...

OpcUa_NodeId *	OpcUa_Variable_GetDataType (OpcUa_Void *pObj)
	OpcUa_Variable_DataType function implementation. More...

OpcUa_Void	OpcUa_Variable_SetValueRank (OpcUa_Void *pObj, OpcUa_Int32 a_ValueRank)
	OpcUa_Variable_SetValueRank function implementation. More...

OpcUa_StatusCode	OpcUa_Variable_SetArrayDimensions (OpcUa_Void pObj, OpcUa_UInt32 a_pArrayDimensions, OpcUa_Int32 a_NumArrayDimensions)
	OpcUa_Variable_SetArrayDimensions function implementation. More...

OpcUa_StatusCode	OpcUa_Variable_AttachArrayDimensions (OpcUa_Void pObj, OpcUa_UInt32 a_pArrayDimensions, OpcUa_Int32 a_NumArrayDimensions)
	OpcUa_Variable_AttachArrayDimensions function implementation. More...

OpcUa_Void	OpcUa_Variable_SetAccessLevel (OpcUa_Void *pObj, OpcUa_Byte level)
	OpcUa_Variable_SetAccessLevel function implementation. More...

OpcUa_Byte	OpcUa_Variable_GetAccessLevel (OpcUa_Void *pObj)
	OpcUa_Variable_GetAccessLevel function implementation. More...

OpcUa_Void	OpcUa_Variable_SetMinimumSamplingInterval (OpcUa_Void *pObj, OpcUa_Double interval)
	OpcUa_Variable_SetMinimumSamplingInterval function implementation. More...

OpcUa_Double	OpcUa_Variable_GetMinimumSamplingInterval (OpcUa_Void *pObj)
	OpcUa_Variable_GetMinimumSamplingInterval function implementation. More...

OpcUa_Void	OpcUa_Variable_SetHistorizing (OpcUa_Void *pObj, OpcUa_Boolean historizing)
	OpcUa_Variable_SetHistorizing function implementation. More...

OpcUa_Boolean	OpcUa_Variable_GetHistorizing (OpcUa_Void *pObj)
	OpcUa_Variable_GetHistorizing function implementation. More...

OpcUa_VariableType *	OpcUa_VariableType_Create ()
	Create a new VariableType. More...

OpcUa_Variant *	OpcUa_VariableType_GetValue (OpcUa_Void *pObj)
	OpcUa_VariableType_GetValue function implementation. More...

OpcUa_NodeId *	OpcUa_VariableType_GetDataType (OpcUa_Void *pObj)
	OpcUa_VariableType_GetIsAbstract function implementation. More...

OpcUa_Int32	OpcUa_VariableType_GetValueRank (OpcUa_Void *pObj)
	OpcUa_VariableType_GetValueRank function implementation. More...

OpcUa_Int32	OpcUa_VariableType_GetNumArrayDimensions (OpcUa_Void *pObj)
	OpcUa_VariableType_GetNumArrayDimensions function implementation. More...

OpcUa_UInt32 *	OpcUa_VariableType_GetArrayDimensions (OpcUa_Void *pObj)
	OpcUa_VariableType_GetArrayDimensions function implementation. More...

OpcUa_Boolean	OpcUa_VariableType_GetIsAbstract (OpcUa_Void *pObj)
	OpcUa_VariableType_GetIsAbstract function implementation. More...

OpcUa_Void	OpcUa_VariableType_SetValue (OpcUa_Void pObj, OpcUa_Variant pValue)
	OpcUa_VariableType_SetValue function implementation. More...

OpcUa_Void	OpcUa_VariableType_SetDataType (OpcUa_Void pObj, OpcUa_NodeId a_pDataType)
	OpcUa_VariableType_SetDataType function implementation. More...

OpcUa_Void	OpcUa_VariableType_SetDataType_Numeric (OpcUa_Void *pObj, OpcUa_UInt32 a_Id, OpcUa_UInt16 a_NamespaceIndex)
	OpcUa_VariableType_SetDataType_Numeric function implementation. More...

OpcUa_Void	OpcUa_VariableType_SetValueRank (OpcUa_Void *pObj, OpcUa_Int32 a_ValueRank)
	OpcUa_VariableType_SetValueRank function implementation. More...

OpcUa_StatusCode	OpcUa_VariableType_SetArrayDimensions (OpcUa_Void pObj, OpcUa_UInt32 a_pArrayDimensions, OpcUa_Int32 a_NumArrayDimensions)
	OpcUa_VariableType_SetArrayDimensions function implementation. More...

OpcUa_StatusCode	OpcUa_VariableType_AttachArrayDimensions (OpcUa_Void pObj, OpcUa_UInt32 a_pArrayDimensions, OpcUa_Int32 a_NumArrayDimensions)
	OpcUa_VariableType_AttachArrayDimensions function implementation. More...

OpcUa_Void	OpcUa_VariableType_SetIsAbstract (OpcUa_Void *pObj, OpcUa_Boolean a_IsAbstract)
	OpcUa_VariableType_SetIsAbstract function implementation. More...

OpcUa_View *	OpcUa_View_Create ()
	Create a new View. More...

OpcUa_Byte	OpcUa_View_GetEventNotifier (OpcUa_Void *pObj)
	OpcUa_View_GetEventNotifier function implementation. More...

OpcUa_Boolean	OpcUa_View_GetContainsNoLoops (OpcUa_Void *pObj)
	OpcUa_View_GetContainsNoLoops function implementation. More...

OpcUa_Void	OpcUa_View_SetEventNotifier (OpcUa_Void *pObj, OpcUa_Byte a_EventNotifier)
	OpcUa_View_SetEventNotifier function implementation. More...

OpcUa_Void	OpcUa_View_SetContainsNoLoops (OpcUa_Void *pObj, OpcUa_Boolean a_ContainsNoLoops)
	OpcUa_View_SetContainsNoLoops function implementation. More...

OpcUa_Reference *	OpcUa_Reference_Create ()
	ToDoDoc. More...

OpcUa_Void	OpcUa_Reference_Initialize (OpcUa_Reference *pReference)
	ToDoDoc. More...

OpcUa_Void	OpcUa_Reference_Clear (OpcUa_Reference *pReference)
	ToDoDoc. More...

OpcUa_Void	OpcUa_Reference_Delete (OpcUa_Reference *pReference)
	ToDoDoc. More...

OpcUa_Void	OpcUa_ReferenceVector_Initialize (UaBase_Vector *pReferenceVector)
	OpcUa_ReferenceVector_Initialize. More...

OpcUa_Void	OpcUa_ReferenceVector_Delete (UaBase_Vector *pReferenceVector)
	OpcUa_ReferenceVector_Delete. More...

OpcUa_BaseNode_DefaultValues *	OpcUa_BaseNode_DefaultValues_Get ()
	ToDoDoc. More...

OpcUa_Boolean	OpcUa_BaseNode_HasAttribute (OpcUa_NodeType a_NodeType, OpcUa_UInt32 a_AttributeId)
	ToDoDoc. More...

Detailed Description

Typedef Documentation

typedef enum _NodeTypes OpcUa_NodeType

An Enumeration of NodeTypes.

typedef enum _TargetType TargetType

Indicates if a OpcUa_Reference is pointing to a OpcUa_BaseNode or to a OpcUa_NodeId.

Enumeration Type Documentation

enum _NodeTypes

An Enumeration of NodeTypes.

enum _TargetType

Indicates if a OpcUa_Reference is pointing to a OpcUa_BaseNode or to a OpcUa_NodeId.

Enumerator
TargetTypeNode	The reference is pointing to a OpcUa_BaseNode.
TargetTypeNodeId	The reference is pointing to a OpcUa_NodeId.

Function Documentation

OpcUa_StatusCode OpcUa_BaseNode_AddReference	(	OpcUa_Void *	pObj,
		OpcUa_Reference *	pReference
	)

Add the given reference to a OpcUa_BaseNode.

Please note: adding a reference of targetType 'TargetTypeNode' without the inverse counterpart can lead to dangling pointers if the target node is deleted. It is important to either create the inverse reference, too, or to delete the according reference if the target node is deleted. Use OpcUa_BaseNode_AddReferenceToNode or OpcUa_BaseNode_AddReferenceToNodeId instead to avoid any possible errors.

Parameters

pObj	The node to add the reference to.
pReference	The reference to add to pObj.

Returns: OpcUa_Good on success.

OpcUa_StatusCode OpcUa_BaseNode_AddReferenceToNode	(	OpcUa_Void *	pObj,
		OpcUa_BaseNode *	pNode,
		OpcUa_NodeId *	pRefType,
		OpcUa_Boolean	AddInverseReference
	)

Add a reference pointing to another OpcUa_BaseNode.

If AddInverseReference is false, a reference of targetType 'TargetTypeNodeId' is created instead (using OpcUa_BaseNode_AddReferenceToNodeId) to prevent dangling pointers if the target node is deleted.

Parameters

pObj	The starting node of the reference to create.
pNode	The target node of the reference to create.
pRefType	The reference type to set.
AddInverseReference	If true, the inverse counterpart to the reference is created at pNode.

Returns: OpcUa_Good on success.

OpcUa_StatusCode OpcUa_BaseNode_AddReferenceToNodeId	(	OpcUa_Void *	pObj,
		OpcUa_NodeId *	pNodeId,
		OpcUa_NodeId *	pRefType
	)

Add a reference pointing to a OpcUa_NodeId.

Parameters

pObj	The starting node of the reference to create.
pNodeId	The NodeId the reference should point to.
pRefType	The reference type to set.

Returns: OpcUa_Good on success.

OpcUa_StatusCode OpcUa_BaseNode_AttachBrowseName	(	OpcUa_Void *	pObj,
		OpcUa_QualifiedName *	pBrowseName
	)

Attaches the given string to the nodes browse name.

This means the node takes ownership of the string and frees it when the node is destroyed. You must not delete the string yourself.

Parameters

pObj	pointer referencing this object.
pBrowseName	BrowseName that should be attached.

Returns: the OpcUa_StatusCode

OpcUa_StatusCode OpcUa_BaseNode_AttachDescription	(	OpcUa_Void *	pObj,
		OpcUa_LocalizedText *	pDescription
	)

OpcUa_BaseNode_AttachDescription function implementation.

Parameters

pObj	pointer referencing this object.
pDescription	the Description of the node with a given text and a given localized description.

Returns: the OpcUa_StatusCode

OpcUa_StatusCode OpcUa_BaseNode_AttachDisplayName	(	OpcUa_Void *	pObj,
		OpcUa_LocalizedText *	pDisplayName
	)

OpcUa_BaseNode_AttachDisplayName function implementation.

Parameters

pObj	pointer referencing this object.
pDisplayName	the full name which will be displayed in a graphical tool.

Returns: the OpcUa_StatusCode

OpcUa_BaseNode_DefaultValues * OpcUa_BaseNode_DefaultValues_Get ( )

ToDoDoc.

Returns: ToDoDoc

OpcUa_QualifiedName * OpcUa_BaseNode_GetBrowseName ( OpcUa_Void * pObj )

OpcUa_BaseNode_GetBrowseName function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_LocalizedText * OpcUa_BaseNode_GetDescription ( OpcUa_Void * pObj )

OpcUa_BaseNode_GetDescription function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_LocalizedText * OpcUa_BaseNode_GetDisplayName ( OpcUa_Void * pObj )

OpcUa_BaseNode_GetDisplayName function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_NodeId * OpcUa_BaseNode_GetId ( OpcUa_Void * pObj )

OpcUa_BaseNode_GetId function implementation.

Parameters

pObj	pointer referencing this object.

UaServer_iNode * OpcUa_BaseNode_GetINode ( OpcUa_Void * pObj )

OpcUa_BaseNode_GetINode function implementation.

Parameters

pObj	pointer referencing this object.

UaBase_Vector * OpcUa_BaseNode_GetReferences ( OpcUa_Void * pObj )

OpcUa_BaseNode_GetReferences function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_Void * OpcUa_BaseNode_GetUserData ( OpcUa_Void * pObj )

OpcUa_BaseNode_GetUserData function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_UInt32 OpcUa_BaseNode_GetWriteMask ( OpcUa_Void * pObj )

OpcUa_BaseNode_GetWriteMask function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_Boolean OpcUa_BaseNode_HasAttribute	(	OpcUa_NodeType	a_NodeType,
		OpcUa_UInt32	a_AttributeId
	)

ToDoDoc.

Parameters

[in]	a_NodeType	ToDoDoc
[in]	a_AttributeId	ToDoDoc

Returns: ToDoDoc

OpcUa_Boolean OpcUa_BaseNode_HasReferences ( OpcUa_Void * pObj )

OpcUa_BaseNode_HasReferences function implementation.

Parameters

pObj	pointer referencing this object.

Returns: true if the node has a reference, false if not.

OpcUa_StatusCode OpcUa_BaseNode_RemoveReferences ( OpcUa_Void * pObj )

OpcUa_BaseNode_RemoveReferences function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the OPC UA Status code.

OpcUa_StatusCode OpcUa_BaseNode_RemoveReferenceToNode	(	OpcUa_Void *	pObj,
		OpcUa_BaseNode *	pNode,
		OpcUa_NodeId *	pRefType,
		OpcUa_Boolean	RemoveInverseReference
	)

Removes a reference to a OpcUa_BaseNode (or subtype) from a OpcUa_BaseNode (or subtype)

Parameters

[in]	pObj	The OpcUa_BaseNode (or subtype) to use
[in]	pNode	The referenced OpcUa_BaseNode (or subtype)
[in]	pRefType	The type of the reference to delete
[in]	RemoveInverseReference	If set to true the inverse reference is removed, too

Returns: OpcUa_Good on success, OpcUa_UncertainReferenceNotDeleted if RemoveInverseReference == true and the inverse reference could not be found, OpcUa_BadNotFound if the reference could not be found

OpcUa_StatusCode OpcUa_BaseNode_RemoveReferenceToNodeId	(	OpcUa_Void *	pObj,
		OpcUa_NodeId *	pNodeId,
		OpcUa_NodeId *	pRefType
	)

Removes a reference to a NodeId from a OpcUa_BaseNode (or subtype)

Parameters

[in]	pObj	The OpcUa_BaseNode (or subtype) to use
[in]	pNodeId	The referenced NodeId
[in]	pRefType	The type of the reference to delete

Returns: OpcUa_Good on success

OpcUa_StatusCode OpcUa_BaseNode_SetBrowseName	(	OpcUa_Void *	pObj,
		OpcUa_UInt16	NamespaceIndex,
		const OpcUa_CharA *	szName
	)

OpcUa_BaseNode_SetBrowseName function implementation.

Parameters

pObj	pointer referencing this object.
NamespaceIndex	TODO
szName	TODO

Returns: the OpcUa_StatusCode.

OpcUa_StatusCode OpcUa_BaseNode_SetDescription	(	OpcUa_Void *	pObj,
		const OpcUa_CharA *	szLocale,
		const OpcUa_CharA *	szName
	)

OpcUa_BaseNode_SetDescription function implementation.

Parameters

pObj	pointer referencing this object.
szLocale	TODO
szName	TODO

Returns: the OpcUa_StatusCode.

OpcUa_StatusCode OpcUa_BaseNode_SetDisplayName	(	OpcUa_Void *	pObj,
		const OpcUa_CharA *	szLocale,
		const OpcUa_CharA *	szName
	)

OpcUa_BaseNode_SetDisplayName function implementation.

Parameters

pObj	pointer referencing this object.
szLocale	TODO
szName	TODO

Returns: the OpcUa_StatusCode.

OpcUa_Void OpcUa_BaseNode_SetId	(	OpcUa_Void *	pObj,
		OpcUa_NodeId *	a_pId
	)

OpcUa_BaseNode_SetId function implementation.

Parameters

pObj	pointer referencing this object.
a_pId	pointer

OpcUa_Void OpcUa_BaseNode_SetId_Numeric	(	OpcUa_Void *	pObj,
		OpcUa_UInt32	a_Id,
		OpcUa_UInt16	a_NamespaceIndex
	)

OpcUa_BaseNode_SetId_Numeric function implementation.

Parameters

pObj	pointer referencing this object.
a_Id	TODO
a_NamespaceIndex	TODO

OpcUa_Void OpcUa_BaseNode_SetINode	(	OpcUa_Void *	pObj,
		UaServer_iNode *	a_pINode
	)

OpcUa_BaseNode_SetINode function implementation.

Parameters

pObj	pointer referencing this object.
a_pINode	pointer referencing this object.

OpcUa_Void OpcUa_BaseNode_SetUserData	(	OpcUa_Void *	pObj,
		OpcUa_Void *	a_pUserData
	)

OpcUa_BaseNode_SetUserData function implementation.

Parameters

pObj	pointer referencing this object.
a_pUserData	ToDoDoc

OpcUa_Void OpcUa_BaseNode_SetWriteMask	(	OpcUa_Void *	pObj,
		OpcUa_UInt32	a_WriteMask
	)

OpcUa_BaseNode_SetWriteMask function implementation.

Parameters

pObj	pointer referencing this object.
a_WriteMask	write mask argument to set

OpcUa_DataType * OpcUa_DataType_Create ( )

Create a new DataType.

Returns: the created DataType.

OpcUa_Boolean OpcUa_DataType_GetIsAbstract ( OpcUa_Void * pObj )

OpcUa_DataType_GetIsAbstract function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_IsAbstract

OpcUa_Void OpcUa_DataType_SetIsAbstract	(	OpcUa_Void *	pObj,
		OpcUa_Boolean	a_IsAbstract
	)

OpcUa_DataType_SetIsAbstract function implementation.

Parameters

pObj	pointer referencing this object.
a_IsAbstract	value to set

OpcUa_Method * OpcUa_Method_Create ( )

Create a new Method.

Returns: the created Method.

OpcUa_Boolean OpcUa_Method_GetExecutable ( OpcUa_Void * pObj )

OpcUa_Method_GetExecutable function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_Executable

OpcUa_Boolean OpcUa_Method_GetUserExecutable ( OpcUa_Void * pObj )

OpcUa_Method_GetUserExecutable function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_UserExecutable

OpcUa_Void OpcUa_Method_SetExecutable	(	OpcUa_Void *	pObj,
		OpcUa_Boolean	a_Executable
	)

OpcUa_Method_SetExecutable function implementation.

Parameters

pObj	pointer referencing this object.
a_Executable	value to set

OpcUa_Void OpcUa_Method_SetUserExecutable	(	OpcUa_Void *	pObj,
		OpcUa_Boolean	a_UserExecutable
	)

OpcUa_Method_SetUserExecutable function implementation.

Parameters

pObj	pointer referencing this object.
a_UserExecutable	value to set

OpcUa_Object * OpcUa_Object_Create ( )

Create a new Object.

Returns: the created Object.

OpcUa_Byte OpcUa_Object_GetEventNotifier ( OpcUa_Void * pObj )

OpcUa_Object_GetEventNotifier function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_EventNotifier

OpcUa_Void OpcUa_Object_SetEventNotifier	(	OpcUa_Void *	pObj,
		OpcUa_Byte	a_EventNotifier
	)

OpcUa_Object_SetEventNotifier function implementation.

Parameters

pObj	pointer referencing this object.
a_EventNotifier	value to set

OpcUa_ObjectType * OpcUa_ObjectType_Create ( )

Create a new ObjectType.

Returns: the created ObjectType.

OpcUa_Boolean OpcUa_ObjectType_GetIsAbstract ( OpcUa_Void * pObj )

OpcUa_ObjectType_GetIsAbstract function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_IsAbstract

OpcUa_Void OpcUa_ObjectType_SetIsAbstract	(	OpcUa_Void *	pObj,
		OpcUa_Boolean	a_IsAbstract
	)

OpcUa_ObjectType_SetIsAbstract function implementation.

Parameters

pObj	pointer referencing this object.
a_IsAbstract	value to set

OpcUa_Void OpcUa_Reference_Clear ( OpcUa_Reference * pReference )

ToDoDoc.

Parameters

[in] pReference ToDoDoc

OpcUa_Reference * OpcUa_Reference_Create ( )

ToDoDoc.

Returns: ToDoDoc

OpcUa_Void OpcUa_Reference_Delete ( OpcUa_Reference * pReference )

ToDoDoc.

Parameters

[in] pReference ToDoDoc

OpcUa_Void OpcUa_Reference_Initialize ( OpcUa_Reference * pReference )

ToDoDoc.

Parameters

[in] pReference ToDoDoc

OpcUa_StatusCode OpcUa_ReferenceType_AttachInverseName	(	OpcUa_Void *	pObj,
		OpcUa_LocalizedText *	a_pInverseName
	)

OpcUa_ReferenceType_AttachInverseName function implementation.

Parameters

pObj	pointer referencing this object.
a_pInverseName	the full inverse name.

Returns: the OpcUa_StatusCode

OpcUa_ReferenceType * OpcUa_ReferenceType_Create ( )

Create a new ReferenceType.

Returns: the created ReferenceType.

OpcUa_LocalizedText * OpcUa_ReferenceType_GetInverseName ( OpcUa_Void * pObj )

OpcUa_ReferenceType_GetInverseName function implementation.

Parameters

pObj	pointer referencing this object.

Returns: pointer to m_InverseName

OpcUa_Boolean OpcUa_ReferenceType_GetIsAbstract ( OpcUa_Void * pObj )

OpcUa_ReferenceType_GetIsAbstract function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_IsAbstract

OpcUa_Boolean OpcUa_ReferenceType_GetSymmetric ( OpcUa_Void * pObj )

OpcUa_ReferenceType_GetSymmetric function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_Symmetric

OpcUa_StatusCode OpcUa_ReferenceType_SetInverseName	(	OpcUa_Void *	pObj,
		const OpcUa_CharA *	szLocale,
		const OpcUa_CharA *	szInverseName
	)

OpcUa_ReferenceType_SetInverseName function implementation.

Parameters

pObj	pointer referencing this object.
szLocale	TODO
szInverseName	TODO

Returns: the OpcUa_StatusCode.

OpcUa_Void OpcUa_ReferenceType_SetIsAbstract	(	OpcUa_Void *	pObj,
		OpcUa_Boolean	a_IsAbstract
	)

OpcUa_ReferenceType_SetIsAbstract function implementation.

Parameters

pObj	pointer referencing this object.
a_IsAbstract	value to set

OpcUa_Void OpcUa_ReferenceType_SetSymmetric	(	OpcUa_Void *	pObj,
		OpcUa_Boolean	a_Symmetric
	)

OpcUa_ReferenceType_SetSymmetric function implementation.

Parameters

pObj	pointer referencing this object.
a_Symmetric	value to set

OpcUa_Void OpcUa_ReferenceVector_Delete ( UaBase_Vector * pReferenceVector )

OpcUa_ReferenceVector_Delete.

Parameters

pReferenceVector pointer to vector with references to delete

OpcUa_Void OpcUa_ReferenceVector_Initialize ( UaBase_Vector * pReferenceVector )

OpcUa_ReferenceVector_Initialize.

Parameters

pReferenceVector pointer to vector for references to initialize

OpcUa_StatusCode OpcUa_Variable_AttachArrayDimensions	(	OpcUa_Void *	pObj,
		OpcUa_UInt32 *	a_pArrayDimensions,
		OpcUa_Int32	a_NumArrayDimensions
	)

OpcUa_Variable_AttachArrayDimensions function implementation.

Parameters

pObj	pointer referencing this object.
a_pArrayDimensions	TODO
a_NumArrayDimensions	TODO

OpcUa_StatusCode OpcUa_Variable_AttachValue	(	OpcUa_Void *	pObj,
		OpcUa_Variant *	pValue
	)

OpcUa_Variable_AttachValue function implementation.

Parameters

pObj	pointer referencing this object.
pValue	TODO

OpcUa_Variable * OpcUa_Variable_Create ( )

Create a new Variable.

Returns: the created Variable.

OpcUa_Byte OpcUa_Variable_GetAccessLevel ( OpcUa_Void * pObj )

OpcUa_Variable_GetAccessLevel function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_UInt32 * OpcUa_Variable_GetArrayDimensions ( OpcUa_Void * pObj )

OpcUa_Variable_GetArrayDimensions function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_NodeId * OpcUa_Variable_GetDataType ( OpcUa_Void * pObj )

OpcUa_Variable_DataType function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_Boolean OpcUa_Variable_GetHistorizing ( OpcUa_Void * pObj )

OpcUa_Variable_GetHistorizing function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_Double OpcUa_Variable_GetMinimumSamplingInterval ( OpcUa_Void * pObj )

OpcUa_Variable_GetMinimumSamplingInterval function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_Int32 OpcUa_Variable_GetNumArrayDimensions ( OpcUa_Void * pObj )

OpcUa_Variable_GetNumArrayDimensions function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_Variant * OpcUa_Variable_GetValue ( OpcUa_Void * pObj )

OpcUa_GetVariable_Value function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_Int32 OpcUa_Variable_GetValueRank ( OpcUa_Void * pObj )

OpcUa_Variable_GetValueRank function implementation.

Parameters

pObj	pointer referencing this object.

OpcUa_Void OpcUa_Variable_SetAccessLevel	(	OpcUa_Void *	pObj,
		OpcUa_Byte	level
	)

OpcUa_Variable_SetAccessLevel function implementation.

Parameters

pObj	pointer referencing this object.
level	TODO

OpcUa_StatusCode OpcUa_Variable_SetArrayDimensions	(	OpcUa_Void *	pObj,
		OpcUa_UInt32 *	a_pArrayDimensions,
		OpcUa_Int32	a_NumArrayDimensions
	)

OpcUa_Variable_SetArrayDimensions function implementation.

Parameters

pObj	pointer referencing this object.
a_pArrayDimensions	TODO
a_NumArrayDimensions	TODO

OpcUa_Void OpcUa_Variable_SetDataType	(	OpcUa_Void *	pObj,
		OpcUa_NodeId *	a_pDataType
	)

Set the data type attribute of an OpcUa_Variable.

Parameters

[in]	pObj	Pointer to the variable to modify
[in]	a_pDataType	The data type to set

OpcUa_Void OpcUa_Variable_SetDataType_Numeric	(	OpcUa_Void *	pObj,
		OpcUa_UInt32	a_Id,
		OpcUa_UInt16	a_NamespaceIndex
	)

Set the data type attribute of an OpcUa_Variable.

This is a convenient alternative for OpcUa_Variable_SetDataType if the data type to set has a numeric NodeId.

Parameters

[in]	pObj	Pointer to the variable to modify
[in]	a_Id	The numeric identifier of the data type NodeId
[in]	a_NamespaceIndex	The namespace index of the data type NodeId

OpcUa_Void OpcUa_Variable_SetHistorizing	(	OpcUa_Void *	pObj,
		OpcUa_Boolean	historizing
	)

OpcUa_Variable_SetHistorizing function implementation.

Parameters

pObj	pointer referencing this object.
historizing	a boolean value which indicates if historizing should be available or not.

OpcUa_Void OpcUa_Variable_SetMinimumSamplingInterval	(	OpcUa_Void *	pObj,
		OpcUa_Double	interval
	)

OpcUa_Variable_SetMinimumSamplingInterval function implementation.

Parameters

pObj	pointer referencing this object.
interval	the interval of the minimum sampling rate.

OpcUa_Void OpcUa_Variable_SetValue	(	OpcUa_Void *	pObj,
		OpcUa_Variant *	pValue
	)

OpcUa_Variable_SetValue function implementation.

Parameters

pObj	pointer referencing this object.
pValue	the value as a variant to be set.

OpcUa_Void OpcUa_Variable_SetValueRank	(	OpcUa_Void *	pObj,
		OpcUa_Int32	a_ValueRank
	)

OpcUa_Variable_SetValueRank function implementation.

Parameters

pObj	pointer referencing this object.
a_ValueRank	TODO

OpcUa_StatusCode OpcUa_VariableType_AttachArrayDimensions	(	OpcUa_Void *	pObj,
		OpcUa_UInt32 *	a_pArrayDimensions,
		OpcUa_Int32	a_NumArrayDimensions
	)

OpcUa_VariableType_AttachArrayDimensions function implementation.

Parameters

pObj	pointer referencing this object.
a_pArrayDimensions	TODO
a_NumArrayDimensions	TODO

OpcUa_VariableType * OpcUa_VariableType_Create ( )

Create a new VariableType.

Returns: the created VariableType.

OpcUa_UInt32 * OpcUa_VariableType_GetArrayDimensions ( OpcUa_Void * pObj )

OpcUa_VariableType_GetArrayDimensions function implementation.

Parameters

pObj	pointer referencing this object.

Returns: pointer to m_ArrayDimensions

OpcUa_NodeId * OpcUa_VariableType_GetDataType ( OpcUa_Void * pObj )

OpcUa_VariableType_GetIsAbstract function implementation.

Parameters

pObj	pointer referencing this object.

Returns: pointer to m_DataType

OpcUa_Boolean OpcUa_VariableType_GetIsAbstract ( OpcUa_Void * pObj )

OpcUa_VariableType_GetIsAbstract function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_IsAbstract

OpcUa_Int32 OpcUa_VariableType_GetNumArrayDimensions ( OpcUa_Void * pObj )

OpcUa_VariableType_GetNumArrayDimensions function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_NumArrayDimensions

OpcUa_Variant * OpcUa_VariableType_GetValue ( OpcUa_Void * pObj )

OpcUa_VariableType_GetValue function implementation.

Parameters

pObj	pointer referencing this object.

Returns: pointer to m_Value

OpcUa_Int32 OpcUa_VariableType_GetValueRank ( OpcUa_Void * pObj )

OpcUa_VariableType_GetValueRank function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_ValueRank

OpcUa_StatusCode OpcUa_VariableType_SetArrayDimensions	(	OpcUa_Void *	pObj,
		OpcUa_UInt32 *	a_pArrayDimensions,
		OpcUa_Int32	a_NumArrayDimensions
	)

OpcUa_VariableType_SetArrayDimensions function implementation.

Parameters

pObj	pointer referencing this object.
a_pArrayDimensions	TODO
a_NumArrayDimensions	TODO

OpcUa_Void OpcUa_VariableType_SetDataType	(	OpcUa_Void *	pObj,
		OpcUa_NodeId *	a_pDataType
	)

OpcUa_VariableType_SetDataType function implementation.

Parameters

pObj	pointer referencing this object.
a_pDataType	TODO

OpcUa_Void OpcUa_VariableType_SetDataType_Numeric	(	OpcUa_Void *	pObj,
		OpcUa_UInt32	a_Id,
		OpcUa_UInt16	a_NamespaceIndex
	)

OpcUa_VariableType_SetDataType_Numeric function implementation.

Parameters

pObj	pointer referencing this object.
a_Id	TODO
a_NamespaceIndex	TODO

OpcUa_Void OpcUa_VariableType_SetIsAbstract	(	OpcUa_Void *	pObj,
		OpcUa_Boolean	a_IsAbstract
	)

OpcUa_VariableType_SetIsAbstract function implementation.

Parameters

pObj	pointer referencing this object.
a_IsAbstract	value to set

OpcUa_Void OpcUa_VariableType_SetValue	(	OpcUa_Void *	pObj,
		OpcUa_Variant *	pValue
	)

OpcUa_VariableType_SetValue function implementation.

Parameters

pObj	pointer referencing this object.
pValue	the value as a variant to be set.

OpcUa_Void OpcUa_VariableType_SetValueRank	(	OpcUa_Void *	pObj,
		OpcUa_Int32	a_ValueRank
	)

OpcUa_VariableType_SetValueRank function implementation.

Parameters

pObj	pointer referencing this object.
a_ValueRank	TODO

OpcUa_View * OpcUa_View_Create ( )

Create a new View.

Returns: the created View.

OpcUa_Boolean OpcUa_View_GetContainsNoLoops ( OpcUa_Void * pObj )

OpcUa_View_GetContainsNoLoops function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_ContainsNoLoops

OpcUa_Byte OpcUa_View_GetEventNotifier ( OpcUa_Void * pObj )

OpcUa_View_GetEventNotifier function implementation.

Parameters

pObj	pointer referencing this object.

Returns: the value of m_EventNotifier

OpcUa_Void OpcUa_View_SetContainsNoLoops	(	OpcUa_Void *	pObj,
		OpcUa_Boolean	a_ContainsNoLoops
	)

OpcUa_View_SetContainsNoLoops function implementation.

Parameters

pObj	pointer referencing this object.
a_ContainsNoLoops	ToDoDoc

OpcUa_Void OpcUa_View_SetEventNotifier	(	OpcUa_Void *	pObj,
		OpcUa_Byte	a_EventNotifier
	)

OpcUa_View_SetEventNotifier function implementation.

Parameters

pObj	pointer referencing this object.
a_EventNotifier	value to set

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation