Interface definition of the UaReference. More...

#include <uabasereferences.h>

Inherited by UaGenericReference, UaRefCrossNodeManager, UaRefCrossNodeManagerSingle, UaReferenceCPCopy, UaRefFromState, UaRefGeneratesEvent, UaRefHasCause, UaRefHasComponent, UaRefHasCondition, UaRefHasDescription, UaRefHasEffect, UaRefHasEncoding, UaRefHasEventSource, UaRefHasHistoricalConfiguration, UaRefHasModellingRule, UaRefHasNotifier, UaRefHasOrderedComponent, UaRefHasProperty, UaRefHasSubtype, UaRefHasTypeDefinition, UaRefOrganizes, UaRefOutOfServer, and UaRefToState.

Public Types
enum	CrossNodeManagerReferenceType { UA_NO_CROSSNODEMANAGER = 0, UA_LIST_OF_REFERENCES, UA_SINGLE_REFERENCE }
	Enumeration of cross node manager reference type. More...

Public Member Functions
	UaReference (UaNode pSourceNode, UaNode pTargetNode)
	construction

virtual	~UaReference ()
	destruction

virtual CrossNodeManagerReferenceType	isCrossNodeManagerRef () const
	Checks whether this reference is across node managers or not. More...

virtual OpcUa_Boolean	isOutOfServerRef () const
	Checks whether a Node is out of Servers References. More...

UaNode *	pSourceNode () const
	Get the source Node. More...

UaNode *	pTargetNode () const
	Get the target Node. More...

virtual UaNodeId	referenceTypeId () const =0
	Get the ReferenceType NodeId of the current Reference. More...

virtual OpcUa_Boolean	isSubtypeOf (const OpcUa_NodeId *pNodeId) const =0
	Check whether the current reference is a subtype of the passed reference type node id. More...

void	setSourceNodeInvalid ()
	Set source node to invalid. More...

void	setTargetNodeInvalid ()
	Set target Node to invalid. More...

void	setNextForwardReference (UaReference *pNextReference)
	Set the next reference for a list of forward references. More...

UaReference *	pNextForwardReference ()
	Get the next reference in a list of forward references. More...

void	setNextInverseReference (UaReference *pNextReference)
	Set the next reference for a list of inverse references. More...

UaReference *	pNextInverseReference ()
	Get the next reference in a list of inverse references. More...

Protected Attributes
UaNode *	m_pSourceNode
	Source node of the reference.

UaNode *	m_pTargetNode
	Target node of the reference.

UaReference *	m_pNextForwardReference
	Next reference in a list of forward references.

UaReference *	m_pNextInverseReference
	Next reference in a list of inverse references.

Detailed Description

Interface definition of the UaReference.

Abstract base class for OPC UA references between UA nodes. It is not possible to use the default constructor.

Member Enumeration Documentation

enum UaReference::CrossNodeManagerReferenceType

Enumeration of cross node manager reference type.

Enumerator
UA_NO_CROSSNODEMANAGER	This is not a cross node manager reference
UA_LIST_OF_REFERENCES	This cross node manager reference can have a list of target nodes
UA_SINGLE_REFERENCE	This cross node manager reference has one target node

Member Function Documentation

virtual CrossNodeManagerReferenceType UaReference::isCrossNodeManagerRef ( ) const

inlinevirtual

Checks whether this reference is across node managers or not.

Returns: The type of cross node manager reference or UA_NO_CROSSNODEMANAGER if it is a normal reference.

Reimplemented in UaRefCrossNodeManagerSingle, and UaRefCrossNodeManager.

virtual OpcUa_Boolean UaReference::isOutOfServerRef ( ) const

inlinevirtual

Checks whether a Node is out of Servers References.

Returns: FALSE if out of Server Reference.

Reimplemented in UaRefOutOfServer.

virtual OpcUa_Boolean UaReference::isSubtypeOf ( const OpcUa_NodeId * pNodeId ) const

pure virtual

Check whether the current reference is a subtype of the passed reference type node id.

Parameters

pNodeId NodeId of the requested reference type.

Returns: TRUE if the reference is a subtype of the passed type FALSE if not.

Implemented in UaRefToState, UaRefHasEffect, UaRefHasCause, UaRefFromState, UaRefHasModellingRule, UaRefHasEncoding, UaRefHasDescription, UaRefHasCondition, UaRefGeneratesEvent, UaRefHasTypeDefinition, UaRefHasNotifier, UaRefHasEventSource, UaRefHasSubtype, UaRefHasProperty, UaRefHasOrderedComponent, UaRefHasHistoricalConfiguration, UaRefHasComponent, UaRefOrganizes, UaReferenceCPCopy, UaGenericReference, UaRefOutOfServer, UaRefCrossNodeManagerSingle, and UaRefCrossNodeManager.

UaReference* UaReference::pNextForwardReference ( )

inline

Get the next reference in a list of forward references.

UaReference* UaReference::pNextInverseReference ( )

inline

Get the next reference in a list of inverse references.

UaNode* UaReference::pSourceNode ( ) const

inline

Get the source Node.

Returns: the source Node.

UaNode* UaReference::pTargetNode ( ) const

inline

Get the target Node.

Returns: the target Node.

virtual UaNodeId UaReference::referenceTypeId ( ) const

pure virtual

Get the ReferenceType NodeId of the current Reference.

Returns: the ReferenceTypeId of the current Reference.

Implemented in UaRefToState, UaRefHasEffect, UaRefHasCause, UaRefFromState, UaRefHasModellingRule, UaRefHasEncoding, UaRefHasDescription, UaRefHasCondition, UaRefGeneratesEvent, UaRefHasTypeDefinition, UaRefHasNotifier, UaRefHasEventSource, UaRefHasSubtype, UaRefHasProperty, UaRefHasOrderedComponent, UaRefHasHistoricalConfiguration, UaRefHasComponent, UaRefOrganizes, UaReferenceCPCopy, UaGenericReference, UaRefOutOfServer, UaRefCrossNodeManagerSingle, and UaRefCrossNodeManager.

void UaReference::setNextForwardReference ( UaReference * pNextReference )

inline

Set the next reference for a list of forward references.

void UaReference::setNextInverseReference ( UaReference * pNextReference )

inline

Set the next reference for a list of inverse references.

void UaReference::setSourceNodeInvalid ( )

inline

Set source node to invalid.

void UaReference::setTargetNodeInvalid ( )

inline

Set target Node to invalid.

The documentation for this class was generated from the following files:

D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uabasereferences.h
D:/work/uasdkcpp/src/uaserver/uaservercpp/coremodule/uabasereferences.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

Member Function Documentation