C++ Based OPC UA Client/Server/PubSub SDK
1.7.3.505
|
Generated base class for a AddressSpaceFileType. More...
#include <opcua_addressspacefiletype.h>
Inherits OpcUa::FileType.
Public Member Functions | |
AddressSpaceFileType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an AddressSpaceFileType object using an instance declaration node as base. | |
AddressSpaceFileType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an AddressSpaceFileType object. | |
AddressSpaceFileType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class AddressSpaceFileType with all components. More... | |
virtual UaNodeId | typeDefinitionId () const |
Returns the type definition NodeId for the AddressSpaceFileType. | |
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 UaStatus | ExportNamespace (const ServiceContext &serviceContext) |
Provides a way to export the namespace from the Server address space to the XML file represented by the AddressSpaceFileType. More... | |
virtual OpcUa::BaseMethod * | getExportNamespace () |
Returns the ExportNamespace node. More... | |
virtual const OpcUa::BaseMethod * | getExportNamespace () const |
Returns the ExportNamespace node. More... | |
virtual void | useAccessInfoFromType () |
Applies the NodeAccessInfo set at the AddressSpaceFileType and its children. More... | |
void | useAccessInfoFromInstance (AddressSpaceFileType *pInstance) |
Uses the NodeAccessInfo of pOther and its children. More... | |
void | setCallback (AddressSpaceFileCallback *pCallback) |
Set the instance specific callback for ExportNamespace Method handling. More... | |
Public Member Functions inherited from OpcUa::FileType | |
FileType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL, OpcUa_UInt32 clientProcessingTimeout=0) | |
Construction of the class FileType. More... | |
FileType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL, OpcUa_UInt32 clientProcessingTimeout=0) | |
Construction of the class FileType. More... | |
FileType (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL, OpcUa_UInt32 clientProcessingTimeout=0) | |
Constructs an instance of the class FileType with all components. More... | |
UaString | filePath () const |
Get the file path and name used for this FileType object. | |
bool | setFilePath (const UaString &sFilePath) |
Set file path and name used for FileType object. More... | |
OpcUa_UInt64 | maxFileSize () const |
Get maximum file size accepted for writing. More... | |
void | setMaxFileSize (OpcUa_UInt64 maxFileSize) |
Set the maximum file size accepted for writing. More... | |
virtual UaStatus | Close (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle) |
Closes a file represented by a FileType. More... | |
virtual UaStatus | GetPosition (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle, OpcUa_UInt64 &Position) |
Provides the current position of the FileHandle. More... | |
virtual UaStatus | Open (const ServiceContext &serviceContext, OpcUa_Byte Mode, OpcUa_UInt32 &FileHandle) |
Opens a file represented by an Object of FileType. More... | |
virtual UaStatus | Read (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle, OpcUa_Int32 Length, UaByteString &Data) |
Reads a part of the file starting from the current file position. More... | |
virtual UaStatus | SetPosition (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle, OpcUa_UInt64 Position) |
Sets the current position of the FileHandle. More... | |
virtual UaStatus | Write (const ServiceContext &serviceContext, OpcUa_UInt32 FileHandle, UaByteString &Data) |
Writes a part of the file starting from the current file position. More... | |
OpcUa_UInt32 | getClientProcessingTimeout () const |
Return the maximum time in milliseconds a client can keep a file open without working on it. More... | |
void | setClientProcessingTimeout (OpcUa_UInt32 milliseconds) |
Set the maximum time in milliseconds a client can keep a file open without working on it. More... | |
void | checkTimeout () |
Check the timeout of open file handles and close the handles if timed out. | |
Public Member Functions inherited from OpcUa::FileTypeBase | |
FileTypeBase (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an FileType object using an instance declaration node as base. | |
FileTypeBase (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an FileType object. | |
FileTypeBase (UaBase::Object *pBaseNode, XmlUaNodeFactoryManager *pFactory, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL) | |
Constructs an instance of the class FileTypeBase with all components. More... | |
virtual void | setMimeType (const UaString &MimeType) |
Sets the MimeType value. More... | |
virtual UaString | getMimeType () const |
Returns the value of MimeType. More... | |
virtual void | setOpenCount (OpcUa_UInt16 OpenCount) |
Sets the OpenCount value. More... | |
virtual OpcUa_UInt16 | getOpenCount () const |
Returns the value of OpenCount. More... | |
virtual void | setSize (OpcUa_UInt64 Size) |
Sets the Size value. More... | |
virtual OpcUa_UInt64 | getSize () const |
Returns the value of Size. More... | |
virtual void | setUserWritable (OpcUa_Boolean UserWritable) |
Sets the UserWritable value. More... | |
virtual OpcUa_Boolean | getUserWritable () const |
Returns the value of UserWritable. More... | |
virtual void | setWritable (OpcUa_Boolean Writable) |
Sets the Writable value. More... | |
virtual OpcUa_Boolean | getWritable () const |
Returns the value of Writable. More... | |
virtual OpcUa::PropertyType * | getMimeTypeNode () |
Returns the MimeType node. More... | |
virtual OpcUa::PropertyType * | getOpenCountNode () |
Returns the OpenCount node. More... | |
virtual OpcUa::PropertyType * | getSizeNode () |
Returns the Size node. More... | |
virtual OpcUa::PropertyType * | getUserWritableNode () |
Returns the UserWritable node. More... | |
virtual OpcUa::PropertyType * | getWritableNode () |
Returns the Writable node. More... | |
virtual OpcUa::BaseMethod * | getClose () |
Returns the Close node. | |
virtual OpcUa::BaseMethod * | getGetPosition () |
Returns the GetPosition node. | |
virtual OpcUa::BaseMethod * | getOpen () |
Returns the Open node. | |
virtual OpcUa::BaseMethod * | getRead () |
Returns the Read node. | |
virtual OpcUa::BaseMethod * | getSetPosition () |
Returns the SetPosition node. | |
virtual OpcUa::BaseMethod * | getWrite () |
Returns the Write node. | |
void | useAccessInfoFromInstance (FileTypeBase *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... | |
UaReferenceLists * | getUaReferenceLists () 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... | |
UaNode * | getUaNode () const |
Get the UaNode interface pointer of this node. More... | |
virtual OpcUa_Byte | eventNotifier () const |
Returns the EventNotifier for the BaseObjectType. More... | |
virtual MethodManager * | getMethodManager (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 UserDataBase * | getUserData () 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 NodeAccessInfo * | getAccessInfo () 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 | |
ChainEntry * | find (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... | |
ChainEntry * | remove (const UaNodeId &key, ChainEntry **ppNext) |
removes an entry from the list. More... | |
ChainEntry * | getNext () 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 UaReference * | pTargetNodes () const |
Returns the list of references to target nodes. More... | |
virtual const UaReference * | pSourceNodes () const |
Returns the list of references to source nodes. More... | |
virtual UaNode * | getTargetNodeByBrowseName (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 related type nodes. | |
static void | clearStaticMembers () |
Clear the static members of the class. | |
static void | setDefaultCallback (AddressSpaceFileCallback *pCallback) |
Set the default callback interface for all instances for ExportNamespace Method handling. More... | |
Static Public Member Functions inherited from OpcUa::FileType | |
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 OpcUa::FileTypeBase | |
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 | ~AddressSpaceFileType () |
Destruction. | |
Protected Member Functions inherited from OpcUa::FileType | |
virtual | ~FileType () |
Destruction. | |
virtual UaFile * | createFileAccessObject (Session *pSession, const UaString &sFileName) |
Creates an object with the interface UaFile used to access the file. More... | |
virtual OpcUa_Boolean | checkUserAccess (Session *pSession, UaIODevice::OpenMode openMode) |
Verifies the open mode with the user rights for the file. More... | |
Protected Member Functions inherited from OpcUa::FileTypeBase | |
virtual | ~FileTypeBase () |
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) |
Collect a list of all child nodes. More... | |
Additional Inherited Members | |
Protected Attributes inherited from UaReferenceLists | |
UaReference * | m_pTargetNodes |
List of references to target nodes where this node is the source node. More... | |
UaReference * | m_pLastTargetNode |
Last references in the list of references to the target nodes. More... | |
UaReference * | m_pSourceNodes |
List of references to source nodes where this node is the target node. More... | |
Generated base class for a AddressSpaceFileType.
This class contains the generated base code for the object type AddressSpaceFileType representing an OPC UA ObjectType. This class is used to create the object type and to create and represent instances of the object type in the server address space.
This object type defines the file for a namespace provided by the OPC UA Server.
It represents an XML address space file using the XML schema defined in Part 6 of the OPC UA Specification.
Servers might provide some vendor-specific mechanisms importing parts of an address space as subtype of this object type, for example by defining appropriate methods.
See also AddressSpaceFileType for a documentation of the complete Information Model.
OpcUa::AddressSpaceFileType::AddressSpaceFileType | ( | UaBase::Object * | pBaseNode, |
XmlUaNodeFactoryManager * | pFactory, | ||
NodeManagerConfig * | pNodeConfig, | ||
UaMutexRefCounted * | pSharedMutex = NULL |
||
) |
Constructs an instance of the class AddressSpaceFileType with all components.
[in] | pBaseNode | The "tree" of nodes that specifies the attributes of the instance and its children |
[in] | pFactory | The factory to create the children |
[in] | pNodeConfig | Interface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space |
[in] | pSharedMutex | Shared mutex object used to synchronize access to the variable. Can be NULL if no shared mutex is provided |
|
virtual |
Call method of an UA object.
Implementation of the MethodManager interface method beginCall.
Reimplemented from OpcUa::FileTypeBase.
|
virtual |
Provides a way to export the namespace from the Server address space to the XML file represented by the AddressSpaceFileType.
Value attributes are only exported if they represent static configuration information. The client is expected to call the ExportNamespace method first to update the XML file and then access the file with the methods defined in the FileType.
serviceContext | General context for the service calls containing information like the session object, return diagnostic mask and timeout hint. |
|
virtual |
Returns the ExportNamespace node.
If the ExportNamespace node has not been created yet, this method creates the node and returns it.
|
virtual |
Returns the ExportNamespace node.
If the ExportNamespace node has not been created yet, this method returns NULL.
void OpcUa::AddressSpaceFileType::setCallback | ( | AddressSpaceFileCallback * | pCallback | ) |
Set the instance specific callback for ExportNamespace Method handling.
pCallback | Callback interface. |
|
static |
Set the default callback interface for all instances for ExportNamespace Method handling.
pCallback | Callback interface. |
void OpcUa::AddressSpaceFileType::useAccessInfoFromInstance | ( | AddressSpaceFileType * | pOther | ) |
Uses the NodeAccessInfo of pOther and its children.
|
virtual |
Applies the NodeAccessInfo set at the AddressSpaceFileType and its children.
Reimplemented from OpcUa::FileTypeBase.