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

Wrapper class for the UA stack structure OpcUa_HistoryEventFieldList. More...

#include <uahistoryeventfieldlist.h>

Public Member Functions

 UaHistoryEventFieldList ()
 Constructs an instance of the class UaHistoryEventFieldList with empty default values.
 
 UaHistoryEventFieldList (const UaHistoryEventFieldList &other)
 Constructs an instance of the class UaHistoryEventFieldList with values from another UaHistoryEventFieldList object. More...
 
 UaHistoryEventFieldList (const OpcUa_HistoryEventFieldList &other)
 Constructs an instance of the class UaHistoryEventFieldList with values from another OpcUa_HistoryEventFieldList structure. More...
 
 UaHistoryEventFieldList (const UaVariantArray &eventFields)
 Constructs an instance of the class UaHistoryEventFieldList with values provided in the constructor.
 
 UaHistoryEventFieldList (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaHistoryEventFieldList initialized with value from a UaExtensionObject. More...
 
 UaHistoryEventFieldList (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaHistoryEventFieldList initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaHistoryEventFieldList ()
 Destroys the UaHistoryEventFieldList object.
 
void clear ()
 Clear the data of the UaHistoryEventFieldList. More...
 
bool operator== (const UaHistoryEventFieldList &other) const
 Compare two UaHistoryEventFieldList if they are similar. More...
 
bool operator!= (const UaHistoryEventFieldList &other) const
 Returns true if the other UaHistoryEventFieldList is not equal to this. More...
 
UaHistoryEventFieldListoperator= (const UaHistoryEventFieldList &other)
 Assignment operator. More...
 
OpcUa_HistoryEventFieldList * copy () const
 Copy UaHistoryEventFieldList data to a newly allocated OpcUa_HistoryEventFieldList. More...
 
void copyTo (OpcUa_HistoryEventFieldList *pDst) const
 Copy UaHistoryEventFieldList data to an existing OpcUa_HistoryEventFieldList structure. More...
 
void attach (OpcUa_HistoryEventFieldList *pValue)
 Attaches the data of the parameter pValue. More...
 
OpcUa_HistoryEventFieldList * detach (OpcUa_HistoryEventFieldList *pDst)
 Detaches the internal HistoryEventFieldList structure from this class. More...
 

Static Public Member Functions

static
OpcUa_HistoryEventFieldList * 
clone (const OpcUa_HistoryEventFieldList &source)
 Copy OpcUa_HistoryEventFieldList data to a newly allocated OpcUa_HistoryEventFieldList. More...
 
static void cloneTo (const OpcUa_HistoryEventFieldList &source, OpcUa_HistoryEventFieldList &copy)
 Copy OpcUa_HistoryEventFieldList data to an existing OpcUa_HistoryEventFieldList structure. More...
 

Detailed Description

Wrapper class for the UA stack structure OpcUa_HistoryEventFieldList.

This class encapsulates the native OpcUa_HistoryEventFieldList structure and handles memory allocation and cleanup for you. UaHistoryEventFieldList uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared HistoryEventFieldList it creates a copy for that (copy-on-write). So assigning another UaHistoryEventFieldList or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.

Constructor & Destructor Documentation

UaHistoryEventFieldList::UaHistoryEventFieldList ( const UaHistoryEventFieldList other)

Constructs an instance of the class UaHistoryEventFieldList with values from another UaHistoryEventFieldList object.

Parameters
otherthe other UaHistoryEventFieldList used to initialize the object
UaHistoryEventFieldList::UaHistoryEventFieldList ( const OpcUa_HistoryEventFieldList &  other)

Constructs an instance of the class UaHistoryEventFieldList with values from another OpcUa_HistoryEventFieldList structure.

Parameters
otherthe other OpcUa_HistoryEventFieldList used to initialize the object
UaHistoryEventFieldList::UaHistoryEventFieldList ( const UaExtensionObject extensionObject)

Constructs an instance of the class UaHistoryEventFieldList initialized with value from a UaExtensionObject.

Parameters
extensionObjectthe extension object containing the HistoryEventFieldList
UaHistoryEventFieldList::UaHistoryEventFieldList ( const OpcUa_ExtensionObject &  extensionObject)

Constructs an instance of the class UaHistoryEventFieldList initialized with value from an OpcUa_ExtensionObject structure.

Parameters
extensionObjectthe extension object containing the HistoryEventFieldList

Member Function Documentation

void UaHistoryEventFieldList::attach ( OpcUa_HistoryEventFieldList *  pValue)

Attaches the data of the parameter pValue.

Don't clear the data of pValue afterwards manually, because UaHistoryEventFieldList is responsible for it now.

Parameters
[in]pValueParameter to attach to.
void UaHistoryEventFieldList::clear ( )

Clear the data of the UaHistoryEventFieldList.

OpcUa_HistoryEventFieldList * UaHistoryEventFieldList::clone ( const OpcUa_HistoryEventFieldList &  source)
static

Copy OpcUa_HistoryEventFieldList data to a newly allocated OpcUa_HistoryEventFieldList.

Parameters
sourceSource to clone.
Returns
new copy.
void UaHistoryEventFieldList::cloneTo ( const OpcUa_HistoryEventFieldList &  source,
OpcUa_HistoryEventFieldList &  copy 
)
static

Copy OpcUa_HistoryEventFieldList data to an existing OpcUa_HistoryEventFieldList structure.

Parameters
sourcethe source of the clone operation.
copythe destination of the clone operation.
OpcUa_HistoryEventFieldList * UaHistoryEventFieldList::copy ( ) const

Copy UaHistoryEventFieldList data to a newly allocated OpcUa_HistoryEventFieldList.

Returns
data to a newly allocated OpcUa_HistoryEventFieldList.
void UaHistoryEventFieldList::copyTo ( OpcUa_HistoryEventFieldList *  pDst) const

Copy UaHistoryEventFieldList data to an existing OpcUa_HistoryEventFieldList structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_HistoryEventFieldList * UaHistoryEventFieldList::detach ( OpcUa_HistoryEventFieldList *  pDst)

Detaches the internal HistoryEventFieldList structure from this class.

This way you take over the control of releasing the HistoryEventFieldList data. If more than one reference exists, the data is copied to pDst instead of being detached.

Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
Parameters
[out]pDstPointer to OpcUa_HistoryEventFieldList structure that receives the HistoryEventFieldList data.
bool UaHistoryEventFieldList::operator!= ( const UaHistoryEventFieldList other) const

Returns true if the other UaHistoryEventFieldList is not equal to this.

See Also
operator==
Parameters
otherthe UaHistoryEventFieldList to compare.
Returns
true if other is not equal to this.
UaHistoryEventFieldList & UaHistoryEventFieldList::operator= ( const UaHistoryEventFieldList other)

Assignment operator.

Parameters
otherthe UaHistoryEventFieldList to assign.
Returns
Assignment operator.
bool UaHistoryEventFieldList::operator== ( const UaHistoryEventFieldList other) const

Compare two UaHistoryEventFieldList if they are similar.

Parameters
otherthe UaHistoryEventFieldList to compare.
Returns
true if similar, false if not.

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