C++ Based OPC UA Client/Server/PubSub SDK
1.7.9.586
|
Wrapper class for the UA stack structure OpcUa_PublishedVariableDataType. More...
#include <uapublishedvariabledatatype.h>
Public Member Functions | |
UaPublishedVariableDataType () | |
Constructs an instance of the class UaPublishedVariableDataType with empty default values. | |
UaPublishedVariableDataType (const UaPublishedVariableDataType &other) | |
Constructs an instance of the class UaPublishedVariableDataType with values from another UaPublishedVariableDataType object. More... | |
UaPublishedVariableDataType (const OpcUa_PublishedVariableDataType &other) | |
Constructs an instance of the class UaPublishedVariableDataType with values from another OpcUa_PublishedVariableDataType structure. More... | |
UaPublishedVariableDataType (const UaNodeId &publishedVariable, OpcUa_UInt32 attributeId, OpcUa_Double samplingIntervalHint, OpcUa_UInt32 deadbandType, OpcUa_Double deadbandValue, const UaString &indexRange, const UaVariant &substituteValue, const UaQualifiedNameArray &metaDataProperties) | |
Constructs an instance of the class UaPublishedVariableDataType with values provided in the constructor. | |
UaPublishedVariableDataType (const UaExtensionObject &extensionObject) | |
Constructs an instance of the class UaPublishedVariableDataType initialized with value from a UaExtensionObject. More... | |
UaPublishedVariableDataType (const OpcUa_ExtensionObject &extensionObject) | |
Constructs an instance of the class UaPublishedVariableDataType initialized with value from an OpcUa_ExtensionObject structure. More... | |
~UaPublishedVariableDataType () | |
Destroys the UaPublishedVariableDataType object. | |
void | clear () |
Clear the data of the UaPublishedVariableDataType. More... | |
bool | operator== (const UaPublishedVariableDataType &other) const |
Compare two UaPublishedVariableDataType for equality. More... | |
bool | operator!= (const UaPublishedVariableDataType &other) const |
Compare two UaPublishedVariableDataType for inequality. More... | |
UaPublishedVariableDataType & | operator= (const UaPublishedVariableDataType &other) |
Assignment operator. More... | |
OpcUa_PublishedVariableDataType * | copy () const |
Copy UaPublishedVariableDataType data to a newly allocated OpcUa_PublishedVariableDataType. More... | |
void | copyTo (OpcUa_PublishedVariableDataType *pDst) const |
Copy UaPublishedVariableDataType data to an existing OpcUa_PublishedVariableDataType structure. More... | |
void | attach (OpcUa_PublishedVariableDataType *pValue) |
Attaches to an existing OpcUa_PublishedVariableDataType structure. More... | |
OpcUa_PublishedVariableDataType * | detach (OpcUa_PublishedVariableDataType *pDst) |
Detaches the internal PublishedVariableDataType structure from this class. More... | |
UaNodeId | getPublishedVariable () const |
Returns the PublishedVariable. | |
OpcUa_UInt32 | getAttributeId () const |
Returns the AttributeId. | |
OpcUa_Double | getSamplingIntervalHint () const |
Returns the SamplingIntervalHint. | |
OpcUa_UInt32 | getDeadbandType () const |
Returns the DeadbandType. | |
OpcUa_Double | getDeadbandValue () const |
Returns the DeadbandValue. | |
UaString | getIndexRange () const |
Returns the IndexRange. | |
UaVariant | getSubstituteValue () const |
Returns the SubstituteValue. | |
void | getMetaDataProperties (UaQualifiedNameArray &metaDataProperties) const |
Returns the MetaDataProperties. | |
void | setPublishedVariable (const UaNodeId &publishedVariable) |
Sets the PublishedVariable. | |
void | setAttributeId (OpcUa_UInt32 attributeId) |
Sets the AttributeId. | |
void | setSamplingIntervalHint (OpcUa_Double samplingIntervalHint) |
Sets the SamplingIntervalHint. | |
void | setDeadbandType (OpcUa_UInt32 deadbandType) |
Sets the DeadbandType. | |
void | setDeadbandValue (OpcUa_Double deadbandValue) |
Sets the DeadbandValue. | |
void | setIndexRange (const UaString &indexRange) |
Sets the IndexRange. | |
void | setSubstituteValue (const UaVariant &substituteValue) |
Sets the SubstituteValue. | |
void | setMetaDataProperties (const UaQualifiedNameArray &metaDataProperties) |
Sets the MetaDataProperties. | |
Static Public Member Functions | |
static OpcUa_PublishedVariableDataType * | clone (const OpcUa_PublishedVariableDataType &source) |
Copy OpcUa_PublishedVariableDataType data to a newly allocated OpcUa_PublishedVariableDataType. More... | |
static void | cloneTo (const OpcUa_PublishedVariableDataType &source, OpcUa_PublishedVariableDataType ©) |
Copy OpcUa_PublishedVariableDataType data to an existing OpcUa_PublishedVariableDataType structure. More... | |
Wrapper class for the UA stack structure OpcUa_PublishedVariableDataType.
This class encapsulates the native OpcUa_PublishedVariableDataType structure and handles memory allocation and cleanup for you. UaPublishedVariableDataType uses implicit sharing to avoid needless copying and to boost the performance. Only if you modify a shared PublishedVariableDataType it creates a copy for that (copy-on-write). So assigning another UaPublishedVariableDataType or passing it as parameter needs constant time and is nearly as fast as assigning a pointer.
UaPublishedVariableDataType::UaPublishedVariableDataType | ( | const UaPublishedVariableDataType & | other | ) |
Constructs an instance of the class UaPublishedVariableDataType with values from another UaPublishedVariableDataType object.
other | the other UaPublishedVariableDataType used to initialize the object |
UaPublishedVariableDataType::UaPublishedVariableDataType | ( | const OpcUa_PublishedVariableDataType & | other | ) |
Constructs an instance of the class UaPublishedVariableDataType with values from another OpcUa_PublishedVariableDataType structure.
other | the other OpcUa_PublishedVariableDataType used to initialize the object |
UaPublishedVariableDataType::UaPublishedVariableDataType | ( | const UaExtensionObject & | extensionObject | ) |
Constructs an instance of the class UaPublishedVariableDataType initialized with value from a UaExtensionObject.
extensionObject | the extension object containing the PublishedVariableDataType |
UaPublishedVariableDataType::UaPublishedVariableDataType | ( | const OpcUa_ExtensionObject & | extensionObject | ) |
Constructs an instance of the class UaPublishedVariableDataType initialized with value from an OpcUa_ExtensionObject structure.
extensionObject | the extension object containing the PublishedVariableDataType |
void UaPublishedVariableDataType::attach | ( | OpcUa_PublishedVariableDataType * | pValue | ) |
Attaches to an existing OpcUa_PublishedVariableDataType structure.
Don't manually free the attached structure afterwards, because UaPublishedVariableDataType is responsible for it now.
pValue | [in] Parameter to attach to. |
void UaPublishedVariableDataType::clear | ( | ) |
Clear the data of the UaPublishedVariableDataType.
|
static |
Copy OpcUa_PublishedVariableDataType data to a newly allocated OpcUa_PublishedVariableDataType.
source | Source to clone. |
|
static |
Copy OpcUa_PublishedVariableDataType data to an existing OpcUa_PublishedVariableDataType structure.
source | the source of the clone operation. |
copy | the destination of the clone operation. |
OpcUa_PublishedVariableDataType * UaPublishedVariableDataType::copy | ( | ) | const |
Copy UaPublishedVariableDataType data to a newly allocated OpcUa_PublishedVariableDataType.
void UaPublishedVariableDataType::copyTo | ( | OpcUa_PublishedVariableDataType * | pDst | ) | const |
Copy UaPublishedVariableDataType data to an existing OpcUa_PublishedVariableDataType structure.
pDst | the destination of this copy operation. |
OpcUa_PublishedVariableDataType * UaPublishedVariableDataType::detach | ( | OpcUa_PublishedVariableDataType * | pDst | ) |
Detaches the internal PublishedVariableDataType structure from this class.
This way you take over the control of freeing the PublishedVariableDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.
pDst | [out] Pointer to an OpcUa_PublishedVariableDataType structure that receives the PublishedVariableDataType data. |
bool UaPublishedVariableDataType::operator!= | ( | const UaPublishedVariableDataType & | other | ) | const |
Compare two UaPublishedVariableDataType for inequality.
other | the UaPublishedVariableDataType to compare with. |
UaPublishedVariableDataType & UaPublishedVariableDataType::operator= | ( | const UaPublishedVariableDataType & | other | ) |
Assignment operator.
other | the UaPublishedVariableDataType to assign. |
bool UaPublishedVariableDataType::operator== | ( | const UaPublishedVariableDataType & | other | ) | const |
Compare two UaPublishedVariableDataType for equality.
other | the UaPublishedVariableDataType to compare with. |