UA Server SDK C++ Bundle  1.4.1.271
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
UserDataBase Class Reference

Base class for user data stored in SDK managed objects like UaNode. More...

#include <userdatabase.h>

Inherited by UaBase::BaseNodeStandardUserData, and UserDataVariableGetValue.

Public Types

enum  UserDataType { UserDataType_Custom, UserDataType_GetValue }
 Enumeration used to detect the type of user data for further processing. More...
 

Public Member Functions

 UserDataBase ()
 Creates an object of the type UserDataBase. More...
 
virtual ~UserDataBase ()
 Destroys the UserDataBase object. More...
 
virtual UserDataType getUserDataType () const
 Return the type of user data. More...
 

Detailed Description

Base class for user data stored in SDK managed objects like UaNode.

User data classes need to be derived from this class if the user data should be added to SDK managed objects like a UaNode to allow the SDK managed object to clean the memory of the user data when the SDK managed object is deleted.

Member Enumeration Documentation

Enumeration used to detect the type of user data for further processing.

Enumerator
UserDataType_Custom 

Default type for custom user data

UserDataType_GetValue 

User data class derived from UserDataVariableGetValue. This option can be used for data in memory where the update of the data is not reported through internal events and the data needs to be polled

Constructor & Destructor Documentation

UserDataBase::UserDataBase ( )

Creates an object of the type UserDataBase.

UserDataBase::~UserDataBase ( )
virtual

Destroys the UserDataBase object.

Member Function Documentation

UserDataBase::UserDataType UserDataBase::getUserDataType ( ) const
virtual

Return the type of user data.

The default type is UserDataType_Custom.

Derived classes like the specialized class UserDataVariableGetValue can overwrite this method to set a different UserDataType.

Reimplemented in UaBase::BaseNodeStandardUserData, and UserDataVariableGetValue.


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