C++ Based OPC UA Client/Server/PubSub SDK
1.7.9.586
|
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 for equality. More... | |
bool | operator!= (const UaHistoryEventFieldList &other) const |
Compare two UaHistoryEventFieldList for inequality. More... | |
UaHistoryEventFieldList & | operator= (const UaHistoryEventFieldList &other) |
Assignment operator. More... | |
const OpcUa_Variant & | operator[] (OpcUa_UInt32 index) const |
Index operator. More... | |
OpcUa_Variant & | operator[] (OpcUa_UInt32 index) |
Index 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 to an existing OpcUa_HistoryEventFieldList structure. More... | |
OpcUa_HistoryEventFieldList * | detach (OpcUa_HistoryEventFieldList *pDst) |
Detaches the internal HistoryEventFieldList structure from this class. More... | |
void | getEventFields (UaVariantArray &eventFields) const |
List of selected Event fields. More... | |
void | setEventFields (const UaVariantArray &eventFields) |
List of selected Event fields. 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 OpcUa_HistoryEventFieldList data to an existing OpcUa_HistoryEventFieldList structure. More... | |
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.
UaHistoryEventFieldList::UaHistoryEventFieldList | ( | const UaHistoryEventFieldList & | other | ) |
Constructs an instance of the class UaHistoryEventFieldList with values from another UaHistoryEventFieldList object.
other | the 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.
other | the 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.
extensionObject | the 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.
extensionObject | the extension object containing the HistoryEventFieldList |
void UaHistoryEventFieldList::attach | ( | OpcUa_HistoryEventFieldList * | pValue | ) |
Attaches to an existing OpcUa_HistoryEventFieldList structure.
Don't manually free the attached structure afterwards, because UaHistoryEventFieldList is responsible for it now.
pValue | [in] Parameter to attach to. |
void UaHistoryEventFieldList::clear | ( | ) |
Clear the data of the UaHistoryEventFieldList.
|
static |
Copy OpcUa_HistoryEventFieldList data to a newly allocated OpcUa_HistoryEventFieldList.
source | Source to clone. |
|
static |
Copy OpcUa_HistoryEventFieldList data to an existing OpcUa_HistoryEventFieldList structure.
source | the source of the clone operation. |
copy | the destination of the clone operation. |
OpcUa_HistoryEventFieldList * UaHistoryEventFieldList::copy | ( | ) | const |
Copy UaHistoryEventFieldList data to a newly allocated OpcUa_HistoryEventFieldList.
void UaHistoryEventFieldList::copyTo | ( | OpcUa_HistoryEventFieldList * | pDst | ) | const |
Copy UaHistoryEventFieldList data to an existing OpcUa_HistoryEventFieldList structure.
pDst | the 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 freeing the HistoryEventFieldList data. If more than one reference exists, the data is copied to pDst instead of being detached.
pDst | [out] Pointer to an OpcUa_HistoryEventFieldList structure that receives the HistoryEventFieldList data. |
void UaHistoryEventFieldList::getEventFields | ( | UaVariantArray & | eventFields | ) | const |
List of selected Event fields.
This will be a one to one match with the fields selected in the EventFilter.
bool UaHistoryEventFieldList::operator!= | ( | const UaHistoryEventFieldList & | other | ) | const |
Compare two UaHistoryEventFieldList for inequality.
other | the UaHistoryEventFieldList to compare with. |
UaHistoryEventFieldList & UaHistoryEventFieldList::operator= | ( | const UaHistoryEventFieldList & | other | ) |
Assignment operator.
other | the UaHistoryEventFieldList to assign. |
bool UaHistoryEventFieldList::operator== | ( | const UaHistoryEventFieldList & | other | ) | const |
Compare two UaHistoryEventFieldList for equality.
other | the UaHistoryEventFieldList to compare with. |
const OpcUa_Variant & UaHistoryEventFieldList::operator[] | ( | OpcUa_UInt32 | index | ) | const |
Index operator.
index | the index of the structure to return. |
OpcUa_Variant & UaHistoryEventFieldList::operator[] | ( | OpcUa_UInt32 | index | ) |
Index operator.
index | the index of the structure to return. |
void UaHistoryEventFieldList::setEventFields | ( | const UaVariantArray & | eventFields | ) |
List of selected Event fields.
This will be a one to one match with the fields selected in the EventFilter.