C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
OpcUaPlc::CtrlResourceType Class Reference

Class implementing the UaObject interface for the CtrlResourceType. More...

#include <opcuaplc_ctrlresourcetype.h>

Inherits OpcUaPlc::CtrlResourceTypeBase.

Public Member Functions

 CtrlResourceType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class CtrlResourceType. More...
 
 CtrlResourceType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class CtrlResourceType. More...
 
 CtrlResourceType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class CtrlResourceType with all components. More...
 
virtual UaNodeId typeDefinitionId () const
 Overwrites the typeDefintionId method of the base class returning the type definition NodeId of the Object.
 
void setTypeDefinition (const UaNodeId &typeDefinition)
 Sets the type definition NodeId of the Object.
 
UaStatus addProgramInstance (UaReferenceLists *pProgramOject, NodeManagerConfig *pNodeConfig=NULL)
 Adds the passed program object as component to the Programs configurable object. More...
 
UaStatus addProgramType (UaReferenceLists *pProgramOjectType)
 Adds the passed program object type to the SupportedTypes folder of the Programs configurable object. More...
 
UaStatus addGlobalVar (UaReferenceLists *pGlobalVarNode, NodeManagerConfig *pNodeConfig=NULL)
 Adds the passed GlobalVar node as component to the ParameterSet and to GlobalVars functional group. More...
 
virtual UaStatus MethodSet_Start (const ServiceContext &serviceContext)
 CtrlResourceType method Start. More...
 
virtual UaStatus MethodSet_Stop (const ServiceContext &serviceContext)
 CtrlResourceType method Stop. More...
 
- Public Member Functions inherited from OpcUaPlc::CtrlResourceTypeBase
 CtrlResourceTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an CtrlResourceType object using an instance declaration node as base.
 
 CtrlResourceTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an CtrlResourceType object.
 
 CtrlResourceTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class CtrlResourceTypeBase with all components. More...
 
virtual UaStatus beginCall (MethodManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments)
 Call method of an UA object. More...
 
virtual UaStatus call (const ServiceContext &serviceContext, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments, UaVariantArray &outputArguments, UaStatusCodeArray &inputArgumentResults, UaDiagnosticInfos &inputArgumentDiag)
 Synchronous version of the MethodManager method call executed in a worker thread.
 
virtual
OpcUaDi::FunctionalGroupType
getConfiguration ()
 Returns the Configuration node. More...
 
virtual
OpcUaDi::FunctionalGroupType
getDiagnostic ()
 Returns the Diagnostic node. More...
 
virtual
OpcUaDi::FunctionalGroupType
getGlobalVars ()
 Returns the GlobalVars node. More...
 
virtual
OpcUaDi::ConfigurableObjectType
getPrograms ()
 Returns the Programs node.
 
virtual
OpcUaDi::ConfigurableObjectType
getTasks ()
 Returns the Tasks node.
 
virtual OpcUa::BaseMethodgetMethodSet_Start ()
 Returns the Start node. More...
 
virtual OpcUa::BaseMethodgetMethodSet_Stop ()
 Returns the Stop node. More...
 
virtual void useAccessInfoFromType ()
 Applies the NodeAccessInfo set at the CtrlResourceTypeBase and its children. More...
 
void useAccessInfoFromInstance (CtrlResourceTypeBase *pInstance)
 Uses the NodeAccessInfo of pOther and its children. More...
 
- Public Member Functions inherited from OpcUaDi::DeviceType
 DeviceType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class DeviceType. More...
 
 DeviceType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class DeviceType. More...
 
 DeviceType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class DeviceType with all components. More...
 
- Public Member Functions inherited from OpcUaDi::DeviceTypeBase
 DeviceTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an DeviceType object using an instance declaration node as base.
 
 DeviceTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an DeviceType object.
 
 DeviceTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class DeviceTypeBase with all components. More...
 
virtual void setDeviceHealth (OpcUaDi::DeviceHealthEnumeration DeviceHealth)
 Sets the DeviceHealth value. More...
 
virtual
OpcUaDi::DeviceHealthEnumeration 
getDeviceHealth () const
 Returns the value of DeviceHealth. More...
 
virtual
OpcUa::BaseDataVariableType
getDeviceHealthNode ()
 Returns the DeviceHealth node. More...
 
virtual const
OpcUa::BaseDataVariableType
getDeviceHealthNode () const
 Returns the DeviceHealth node. More...
 
virtual OpcUa::FolderTypegetDeviceHealthAlarms ()
 Returns the DeviceHealthAlarms node. More...
 
virtual const OpcUa::FolderTypegetDeviceHealthAlarms () const
 Returns the DeviceHealthAlarms node. More...
 
virtual OpcUa::FolderTypegetDeviceTypeImage ()
 Returns the DeviceTypeImage node. More...
 
virtual const OpcUa::FolderTypegetDeviceTypeImage () const
 Returns the DeviceTypeImage node. More...
 
virtual OpcUa::FolderTypegetDocumentation ()
 Returns the Documentation node. More...
 
virtual const OpcUa::FolderTypegetDocumentation () const
 Returns the Documentation node. More...
 
virtual OpcUa::FolderTypegetImageSet ()
 Returns the ImageSet node. More...
 
virtual const OpcUa::FolderTypegetImageSet () const
 Returns the ImageSet node. More...
 
virtual OpcUa::FolderTypegetProtocolSupport ()
 Returns the ProtocolSupport node. More...
 
virtual const OpcUa::FolderTypegetProtocolSupport () const
 Returns the ProtocolSupport node. More...
 
virtual UaStatus addCP (OpcUaDi::ConnectionPointType *pCP)
 Adds the passed ConnectionPointType node by creating an HasComponent reference.
 
virtual UaStatus addDeviceTypeImage_Image (OpcUa::BaseDataVariableType *pImage)
 Adds the passed BaseDataVariableType node to the DeviceTypeImage node by creating an HasComponent reference.
 
virtual UaStatus addDocumentation_Document (OpcUa::BaseDataVariableType *pDocument)
 Adds the passed BaseDataVariableType node to the Documentation node by creating an HasComponent reference.
 
virtual UaStatus addImageSet_Image (OpcUa::BaseDataVariableType *pImage)
 Adds the passed BaseDataVariableType node to the ImageSet node by creating an HasComponent reference.
 
virtual UaStatus addProtocolSupport_ProtocolSupport (OpcUa::BaseDataVariableType *pProtocolSupport)
 Adds the passed BaseDataVariableType node to the ProtocolSupport node by creating an HasComponent reference.
 
void useAccessInfoFromInstance (DeviceTypeBase *pInstance)
 Uses the NodeAccessInfo of pOther and its children. More...
 
- Public Member Functions inherited from OpcUaDi::ComponentType
 ComponentType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class ComponentType. More...
 
 ComponentType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class ComponentType. More...
 
 ComponentType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class ComponentType with all components. More...
 
- Public Member Functions inherited from OpcUaDi::ComponentTypeBase
 ComponentTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an ComponentType object using an instance declaration node as base.
 
 ComponentTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an ComponentType object.
 
 ComponentTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class ComponentTypeBase with all components. More...
 
virtual void setAssetId (const UaString &AssetId)
 Sets the AssetId value. More...
 
virtual UaString getAssetId () const
 Returns the value of AssetId. More...
 
virtual void setComponentName (const UaLocalizedText &ComponentName)
 Sets the ComponentName value. More...
 
virtual UaLocalizedText getComponentName (Session *pSession) const
 Returns the value of ComponentName. More...
 
virtual void setDeviceClass (const UaString &DeviceClass)
 Sets the DeviceClass value. More...
 
virtual UaString getDeviceClass () const
 Returns the value of DeviceClass. More...
 
virtual void setDeviceManual (const UaString &DeviceManual)
 Sets the DeviceManual value. More...
 
virtual UaString getDeviceManual () const
 Returns the value of DeviceManual. More...
 
virtual void setDeviceRevision (const UaString &DeviceRevision)
 Sets the DeviceRevision value. More...
 
virtual UaString getDeviceRevision () const
 Returns the value of DeviceRevision. More...
 
virtual void setHardwareRevision (const UaString &HardwareRevision)
 Sets the HardwareRevision value. More...
 
virtual UaString getHardwareRevision () const
 Returns the value of HardwareRevision. More...
 
virtual void setManufacturer (const UaLocalizedText &Manufacturer)
 Sets the Manufacturer value. More...
 
virtual UaLocalizedText getManufacturer (Session *pSession) const
 Returns the value of Manufacturer. More...
 
virtual void setManufacturerUri (const UaString &ManufacturerUri)
 Sets the ManufacturerUri value. More...
 
virtual UaString getManufacturerUri () const
 Returns the value of ManufacturerUri. More...
 
virtual void setModel (const UaLocalizedText &Model)
 Sets the Model value. More...
 
virtual UaLocalizedText getModel (Session *pSession) const
 Returns the value of Model. More...
 
virtual void setProductCode (const UaString &ProductCode)
 Sets the ProductCode value. More...
 
virtual UaString getProductCode () const
 Returns the value of ProductCode. More...
 
virtual void setProductInstanceUri (const UaString &ProductInstanceUri)
 Sets the ProductInstanceUri value. More...
 
virtual UaString getProductInstanceUri () const
 Returns the value of ProductInstanceUri. More...
 
virtual void setRevisionCounter (OpcUa_Int32 RevisionCounter)
 Sets the RevisionCounter value. More...
 
virtual OpcUa_Int32 getRevisionCounter () const
 Returns the value of RevisionCounter. More...
 
virtual void setSerialNumber (const UaString &SerialNumber)
 Sets the SerialNumber value. More...
 
virtual UaString getSerialNumber () const
 Returns the value of SerialNumber. More...
 
virtual void setSoftwareRevision (const UaString &SoftwareRevision)
 Sets the SoftwareRevision value. More...
 
virtual UaString getSoftwareRevision () const
 Returns the value of SoftwareRevision. More...
 
virtual OpcUa::PropertyTypegetAssetIdNode ()
 Returns the AssetId node. More...
 
virtual const OpcUa::PropertyTypegetAssetIdNode () const
 Returns the AssetId node. More...
 
virtual OpcUa::PropertyTypegetComponentNameNode ()
 Returns the ComponentName node. More...
 
virtual const OpcUa::PropertyTypegetComponentNameNode () const
 Returns the ComponentName node. More...
 
virtual OpcUa::PropertyTypegetDeviceClassNode ()
 Returns the DeviceClass node. More...
 
virtual const OpcUa::PropertyTypegetDeviceClassNode () const
 Returns the DeviceClass node. More...
 
virtual OpcUa::PropertyTypegetDeviceManualNode ()
 Returns the DeviceManual node. More...
 
virtual const OpcUa::PropertyTypegetDeviceManualNode () const
 Returns the DeviceManual node. More...
 
virtual OpcUa::PropertyTypegetDeviceRevisionNode ()
 Returns the DeviceRevision node. More...
 
virtual const OpcUa::PropertyTypegetDeviceRevisionNode () const
 Returns the DeviceRevision node. More...
 
virtual OpcUa::PropertyTypegetHardwareRevisionNode ()
 Returns the HardwareRevision node. More...
 
virtual const OpcUa::PropertyTypegetHardwareRevisionNode () const
 Returns the HardwareRevision node. More...
 
virtual OpcUa::PropertyTypegetManufacturerNode ()
 Returns the Manufacturer node. More...
 
virtual const OpcUa::PropertyTypegetManufacturerNode () const
 Returns the Manufacturer node. More...
 
virtual OpcUa::PropertyTypegetManufacturerUriNode ()
 Returns the ManufacturerUri node. More...
 
virtual const OpcUa::PropertyTypegetManufacturerUriNode () const
 Returns the ManufacturerUri node. More...
 
virtual OpcUa::PropertyTypegetModelNode ()
 Returns the Model node. More...
 
virtual const OpcUa::PropertyTypegetModelNode () const
 Returns the Model node. More...
 
virtual OpcUa::PropertyTypegetProductCodeNode ()
 Returns the ProductCode node. More...
 
virtual const OpcUa::PropertyTypegetProductCodeNode () const
 Returns the ProductCode node. More...
 
virtual OpcUa::PropertyTypegetProductInstanceUriNode ()
 Returns the ProductInstanceUri node. More...
 
virtual const OpcUa::PropertyTypegetProductInstanceUriNode () const
 Returns the ProductInstanceUri node. More...
 
virtual OpcUa::PropertyTypegetRevisionCounterNode ()
 Returns the RevisionCounter node. More...
 
virtual const OpcUa::PropertyTypegetRevisionCounterNode () const
 Returns the RevisionCounter node. More...
 
virtual OpcUa::PropertyTypegetSerialNumberNode ()
 Returns the SerialNumber node. More...
 
virtual const OpcUa::PropertyTypegetSerialNumberNode () const
 Returns the SerialNumber node. More...
 
virtual OpcUa::PropertyTypegetSoftwareRevisionNode ()
 Returns the SoftwareRevision node. More...
 
virtual const OpcUa::PropertyTypegetSoftwareRevisionNode () const
 Returns the SoftwareRevision node. More...
 
- Public Member Functions inherited from OpcUaDi::TopologyElementType
 TopologyElementType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class TopologyElementType. More...
 
 TopologyElementType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class TopologyElementType. More...
 
 TopologyElementType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class TopologyElementType with all components. More...
 
UaStatus createParameterSet ()
 Creates the optional ParameterSet object if not available.
 
- Public Member Functions inherited from OpcUaDi::TopologyElementTypeBase
 TopologyElementTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an TopologyElementType object using an instance declaration node as base.
 
 TopologyElementTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an TopologyElementType object.
 
 TopologyElementTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Constructs an instance of the class TopologyElementTypeBase with all components. More...
 
virtual
OpcUaDi::FunctionalGroupType
getIdentification ()
 Returns the Identification node. More...
 
virtual const
OpcUaDi::FunctionalGroupType
getIdentification () const
 Returns the Identification node. More...
 
virtual
OpcUaDi::LockingServicesType
getLock ()
 Returns the Lock node. More...
 
virtual const
OpcUaDi::LockingServicesType
getLock () const
 Returns the Lock node. More...
 
virtual OpcUa::BaseObjectTypegetMethodSet ()
 Returns the MethodSet node. More...
 
virtual const
OpcUa::BaseObjectType
getMethodSet () const
 Returns the MethodSet node. More...
 
virtual OpcUa::BaseObjectTypegetParameterSet ()
 Returns the ParameterSet node. More...
 
virtual const
OpcUa::BaseObjectType
getParameterSet () const
 Returns the ParameterSet node. More...
 
virtual UaStatus addGroup (OpcUaDi::FunctionalGroupType *pGroup)
 Adds the passed FunctionalGroupType node by creating an HasComponent reference.
 
virtual UaStatus addParameterSet_Parameter (OpcUa::BaseDataVariableType *pParameter)
 Adds the passed BaseDataVariableType node to the ParameterSet node by creating an HasComponent reference.
 
virtual UaStatus addMethodSet_Method (OpcUa::BaseMethod *pMethod)
 Adds the passed Method node to the MethodSet node by creating an HasComponent reference.
 
void useAccessInfoFromInstance (TopologyElementTypeBase *pInstance)
 Uses the NodeAccessInfo of pOther and its children. More...
 
- Public Member Functions inherited from OpcUa::BaseObjectType
 BaseObjectType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseObjectType. More...
 
 BaseObjectType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseObjectType. More...
 
UaReferenceListsgetUaReferenceLists () const
 Get the UaReferenceLists interface for the node. More...
 
virtual UaStatus browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
UaNodeId nodeId () const
 Get the NodeId of the current Node. More...
 
virtual UaQualifiedName browseName () const
 Get the browseName of the current Node. More...
 
virtual UaLocalizedText displayName (Session *pSession) const
 Get the displayName as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isDescriptionSupported () const
 Check if Node is DescriptionSupported. More...
 
virtual UaLocalizedText description (Session *pSession) const
 Get the description as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isWriteMaskSupported () const
 Check if Node is WriteMaskSupported. More...
 
virtual OpcUa_UInt32 writeMask () const
 Get the writeMask of the current Node. More...
 
virtual OpcUa_Boolean isUserWriteMaskSupported () const
 Check if Node is UserWriteMaskSupported. More...
 
virtual OpcUa_UInt32 userWriteMask (Session *pSession) const
 Check if Node has a userWriteMask. More...
 
UaNodegetUaNode () const
 Get the UaNode interface pointer of this node. More...
 
virtual OpcUa_Byte eventNotifier () const
 Returns the EventNotifier for the BaseObjectType. More...
 
virtual MethodManagergetMethodManager (UaMethod *pMethod) const
 Returns the method manager interface for the BaseObjectType instance. More...
 
virtual void setUserData (UserDataBase *pUserData)
 Method to set user data stored in this class. More...
 
virtual UserDataBasegetUserData () const
 Method to get the user data stored in this class. More...
 
virtual void setBrowseName (const UaQualifiedName &browseName)
 Sets the browse name attribute value. More...
 
virtual void setDisplayName (const UaLocalizedText &displayName)
 Sets the display name attribute value. More...
 
virtual void setDescription (const UaLocalizedText &description)
 Sets the description attribute value. More...
 
virtual void setWriteMask (OpcUa_UInt32 writeMask)
 Sets the write mask attribute value. More...
 
virtual void setEventNotifier (OpcUa_Byte eventNotifier)
 Sets the eventNotifier attribute value. More...
 
virtual void setModellingRuleId (const UaNodeId &modellingRuleId)
 Set NodeId of the modeling rule for this node. More...
 
virtual UaNodeId modellingRuleId () const
 Get NodeId of the modeling rule for this node. More...
 
void setMethodManager (MethodManager *pMethodManager)
 Allows a class aggregating the object to implement the MethodManager for this object. More...
 
virtual UaStatus setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, NodeAccessInfo *pDefaultPermissions, OpcUa_Boolean checkWriteMask)
 Sets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from MethodManager
 MethodManager ()
 construction
 
virtual ~MethodManager ()
 destruction
 
- Public Member Functions inherited from UaObject
 UaObject (UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the UaObject. More...
 
OpcUa_NodeClass nodeClass () const
 Get the node class of the Node. More...
 
virtual void getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, NodeAccessInfo *pDefaultPermissions, UaDataValue &uaDataValue)
 Gets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from UaNode
 UaNode (UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the UaNode. More...
 
virtual UaNodeId getKey () const
 Get the key of the node used for the hash table. More...
 
virtual NodeAccessInfogetAccessInfo () const
 Returns the access info for this node. More...
 
virtual bool hasAccessInfo () const
 Check if this UaNode has a NodeAccessInfo assigned. More...
 
virtual void useAccessInfoFrom (const UaNode *pOther)
 Set the NodeAccessInfo from another node to this node. More...
 
virtual void setAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
virtual void attachAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
- Public Member Functions inherited from ChainEntry
 ChainEntry ()
 construction
 
ChainEntryfind (const UaNodeId &key, ChainEntry **ppPrevious)
 finds the right entry in the chain. More...
 
void add (ChainEntry *pNewEntry)
 adds a new entry to the list. More...
 
void prepend (ChainEntry *pNewEntry)
 prepends a new entry to the list. More...
 
ChainEntryremove (const UaNodeId &key, ChainEntry **ppNext)
 removes an entry from the list. More...
 
ChainEntrygetNext () const
 Check if there is a chain. More...
 
virtual void setInvalid ()
 Set the entry to invalid. More...
 
void clearChain ()
 Clear the chain when the hashtable is cleared.
 
- Public Member Functions inherited from ReferenceCounter
 ReferenceCounter ()
 construction
 
virtual ~ReferenceCounter ()
 destruction
 
- Public Member Functions inherited from UaReferenceLists
 UaReferenceLists ()
 Constructs the reference lists object.
 
virtual ~UaReferenceLists ()
 Destroys the reference lists object.
 
virtual UaStatus browseReferences (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
virtual UaStatus translateBrowsePathToNodeId (const ServiceContext &serviceContext, const UaNodeId &startingNode, UaRelativePath &relativePath, UaBrowsePathTargets &browsePathTargets)
 Find a node based on an element of an relative path. More...
 
virtual const UaReferencepTargetNodes () const
 Returns the list of references to target nodes. More...
 
virtual const UaReferencepSourceNodes () const
 Returns the list of references to source nodes. More...
 
virtual UaNodegetTargetNodeByBrowseName (const UaQualifiedName &browseName) const
 Searches a target node with the passed browse name and returns the UaNode interface if found. More...
 
virtual void addTargetNode (UaReference *pReference)
 Add a reference to a target node where this node is the source node. More...
 
virtual void addSourceNode (UaReference *pReference)
 Adds a reference to a source node where this node is the target node. More...
 
virtual UaStatus removeSourceNode (UaReference *pReferenceToRemove)
 Remove a reference to a source node where this node is the target node. More...
 
virtual bool removeSourceReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a source node. More...
 
virtual UaStatus removeTargetNode (UaNode *pTargetNode, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual UaStatus removeTargetNode (const UaNodeId &targetNodeId, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual bool removeTargetReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a target node. More...
 
virtual UaStatus removeCrossNodeManagerRef (NodeManager *pNodeManager)
 Remove references to another NodeManager. More...
 
virtual UaStatus invalidateSourceReferences (OpcUa_Boolean deleteSourceReferences)
 Set all references from SourceNodes to this Node invalid. More...
 
virtual UaStatus invalidateTargetReferences (OpcUa_Boolean deleteTargetReferences)
 Set all references to TargetNode of this node invalid. More...
 
virtual UaStatus deleteAllChildren (NodeManagerConfig *pNodeManagerConfig)
 Deletes all child nodes. More...
 

Static Public Member Functions

static void createTypes ()
 Create the type related static members of the class.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUaPlc::CtrlResourceTypeBase
static void createTypes ()
 Create the related type nodes.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUaDi::DeviceType
static void createTypes ()
 Create the type related static members of the class.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUaDi::DeviceTypeBase
static void createTypes ()
 Create the related type nodes.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUaDi::ComponentType
static void createTypes ()
 Create the type related static members of the class.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUaDi::ComponentTypeBase
static void createTypes ()
 Create the related type nodes.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUaDi::TopologyElementType
static void createTypes ()
 Create the type related static members of the class.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUaDi::TopologyElementTypeBase
static void createTypes ()
 Create the related type nodes.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUa::BaseObjectType
static void clearStaticMembers ()
 Clear the static members of the class.
 

Protected Member Functions

virtual ~CtrlResourceType ()
 Destruction.
 
- Protected Member Functions inherited from OpcUaPlc::CtrlResourceTypeBase
virtual ~CtrlResourceTypeBase ()
 Destruction.
 
- Protected Member Functions inherited from OpcUaDi::DeviceType
virtual ~DeviceType ()
 Destruction.
 
- Protected Member Functions inherited from OpcUaDi::DeviceTypeBase
virtual ~DeviceTypeBase ()
 Destruction.
 
- Protected Member Functions inherited from OpcUaDi::ComponentType
virtual ~ComponentType ()
 Destruction.
 
- Protected Member Functions inherited from OpcUaDi::ComponentTypeBase
virtual ~ComponentTypeBase ()
 Destruction.
 
- Protected Member Functions inherited from OpcUaDi::TopologyElementType
virtual ~TopologyElementType ()
 Destruction.
 
- Protected Member Functions inherited from OpcUaDi::TopologyElementTypeBase
virtual ~TopologyElementTypeBase ()
 Destruction.
 
- Protected Member Functions inherited from OpcUa::BaseObjectType
virtual ~BaseObjectType ()
 Destruction of the BaseObjectType. More...
 
- Protected Member Functions inherited from UaObject
virtual ~UaObject ()
 Destruction of the UaObject. More...
 
- Protected Member Functions inherited from UaNode
virtual ~UaNode ()
 Destruction of the UaNode. More...
 
- Protected Member Functions inherited from ChainEntry
virtual ~ChainEntry ()
 destruction
 
- Protected Member Functions inherited from UaReferenceLists
virtual UaStatus collectAllChildrenRecursive (NodeManagerConfig *pNodeManagerConfig, NodesToDeleteCollection &nodesToDeleteCollection, int recursionCounter=0)
 Collect a list of all child nodes. More...
 

Additional Inherited Members

- Protected Attributes inherited from UaReferenceLists
UaReferencem_pTargetNodes
 List of references to target nodes where this node is the source node. More...
 
UaReferencem_pLastTargetNode
 Last references in the list of references to the target nodes. More...
 
UaReferencem_pSourceNodes
 List of references to source nodes where this node is the target node. More...
 

Detailed Description

Class implementing the UaObject interface for the CtrlResourceType.

OPC UA Objects are used to represent systems, system components, real-world objects and software objects. They have the NodeClass Object. The detailed description of Objects and their attributes can be found in the general description of the Object node class.

Object members of the CtrlResourceType:

Browse Name TypeDefinition Modelling Rule See Also
Configuration FunctionalGroupType Optional getConfiguration
GlobalVars FunctionalGroupType Optional getGlobalVars
MethodSet BaseObjectType Optional getMethodSet
Programs ConfigurableObjectType Mandatory getPrograms
Tasks ConfigurableObjectType Mandatory getTasks

Constructor & Destructor Documentation

OpcUaPlc::CtrlResourceType::CtrlResourceType ( const UaNodeId nodeId,
UaObject pInstanceDeclarationObject,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Construction of the class CtrlResourceType.

This constructor is used if the object is created based on an instance declaration of an object type. Since the only difference between the instance declaration object and the instance object are the node id, the pointer to the instance declaration node is used to get the attribute values other than NodeId from the instance declaration node.

The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]pInstanceDeclarationObjectUaObject interface of the instance declaration node used to provide attribute values other than NodeId
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
OpcUaPlc::CtrlResourceType::CtrlResourceType ( const UaNodeId nodeId,
const UaString name,
OpcUa_UInt16  browseNameNameSpaceIndex,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Construction of the class CtrlResourceType.

This constructor is used if the object is not created based on an instance declaration. It defines the name and node id of the object. Additional language specific names and other attribute values can be set with set methods provided by the class.

The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]nameName of the new object. Used as browse name and also as display name if no additional language specific names are set.
[in]browseNameNameSpaceIndexNamespace index used for the browse name
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
OpcUaPlc::CtrlResourceType::CtrlResourceType ( UaBase::Object pBaseNode,
XmlUaNodeFactoryManager pFactory,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Constructs an instance of the class CtrlResourceType with all components.

Parameters
[in]pBaseNodeThe "tree" of nodes that specifies the attributes of the instance and its children
[in]pFactoryThe factory to create the children
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided

Member Function Documentation

UaStatus OpcUaPlc::CtrlResourceType::addGlobalVar ( UaReferenceLists pGlobalVarNode,
NodeManagerConfig pNodeConfig = NULL 
)

Adds the passed GlobalVar node as component to the ParameterSet and to GlobalVars functional group.

Adds the node to the node management, creates a HasComponent reference from the ParameterSet and an Organizes reference from the GlobalVars functional group.

Parameters
[in]pGlobalVarNodeGlobel variable node to add
[in]pNodeConfigOptional NodeConfig interface pointer representing the NodeManager responsible for the new node. By default the NodeManager of the resource node is used.
UaStatus OpcUaPlc::CtrlResourceType::addProgramInstance ( UaReferenceLists pProgramOject,
NodeManagerConfig pNodeConfig = NULL 
)

Adds the passed program object as component to the Programs configurable object.

Adds the node to the node management and creates a HasComponent reference

Parameters
[in]pProgramOjectProgram object node
[in]pNodeConfigOptional NodeConfig interface pointer representing the NodeManager responsible for the new node. By default the NodeManager of the resource node is used.
UaStatus OpcUaPlc::CtrlResourceType::addProgramType ( UaReferenceLists pProgramOjectType)

Adds the passed program object type to the SupportedTypes folder of the Programs configurable object.

Parameters
[in]pProgramOjectTypeProgram object type node
UaStatus OpcUaPlc::CtrlResourceType::MethodSet_Start ( const ServiceContext serviceContext)
virtual

CtrlResourceType method Start.

Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implements OpcUaPlc::CtrlResourceTypeBase.

UaStatus OpcUaPlc::CtrlResourceType::MethodSet_Stop ( const ServiceContext serviceContext)
virtual

CtrlResourceType method Stop.

Parameters
serviceContextGeneral context for the service calls containing information like the session object, return diagnostic mask and timeout hint.

Implements OpcUaPlc::CtrlResourceTypeBase.


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