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

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

#include <uaredundantserverdatatype.h>

Public Member Functions

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

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_RedundantServerDataType.

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

Constructor & Destructor Documentation

UaRedundantServerDataType::UaRedundantServerDataType ( const UaRedundantServerDataType other)

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

Parameters
otherthe other UaRedundantServerDataType used to initialize the object
UaRedundantServerDataType::UaRedundantServerDataType ( const OpcUa_RedundantServerDataType &  other)

Constructs an instance of the class UaRedundantServerDataType with values from another OpcUa_RedundantServerDataType structure.

Parameters
otherthe other OpcUa_RedundantServerDataType used to initialize the object
UaRedundantServerDataType::UaRedundantServerDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the RedundantServerDataType
UaRedundantServerDataType::UaRedundantServerDataType ( const OpcUa_ExtensionObject &  extensionObject)

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

Parameters
extensionObjectthe extension object containing the RedundantServerDataType

Member Function Documentation

void UaRedundantServerDataType::attach ( OpcUa_RedundantServerDataType *  pValue)

Attaches the data of the parameter pValue.

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

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

Clear the data of the UaRedundantServerDataType.

OpcUa_RedundantServerDataType * UaRedundantServerDataType::clone ( const OpcUa_RedundantServerDataType &  source)
static

Copy OpcUa_RedundantServerDataType data to a newly allocated OpcUa_RedundantServerDataType.

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

Copy OpcUa_RedundantServerDataType data to an existing OpcUa_RedundantServerDataType structure.

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

Copy UaRedundantServerDataType data to a newly allocated OpcUa_RedundantServerDataType.

Returns
data to a newly allocated OpcUa_RedundantServerDataType.
void UaRedundantServerDataType::copyTo ( OpcUa_RedundantServerDataType *  pDst) const

Copy UaRedundantServerDataType data to an existing OpcUa_RedundantServerDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_RedundantServerDataType * UaRedundantServerDataType::detach ( OpcUa_RedundantServerDataType *  pDst)

Detaches the internal RedundantServerDataType structure from this class.

This way you take over the control of releasing the RedundantServerDataType 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_RedundantServerDataType structure that receives the RedundantServerDataType data.
bool UaRedundantServerDataType::operator!= ( const UaRedundantServerDataType other) const

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

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

Assignment operator.

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

Compare two UaRedundantServerDataType if they are similar.

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

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