C++ Based OPC UA Client/Server SDK  1.5.5.355
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 for equality. More...
 
bool operator!= (const UaRedundantServerDataType &other) const
 Compare two UaRedundantServerDataType for inequality. More...
 
UaRedundantServerDataTypeoperator= (const UaRedundantServerDataType &other)
 Assignment operator. More...
 
OpcUa_RedundantServerDataTypecopy () 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 to an existing OpcUa_RedundantServerDataType structure. More...
 
OpcUa_RedundantServerDataTypedetach (OpcUa_RedundantServerDataType *pDst)
 Detaches the internal RedundantServerDataType structure from this class. More...
 
UaString getServerId () const
 The Id of the server (not the URI).
 
OpcUa_Byte getServiceLevel () const
 The service level of the server.
 
OpcUa_ServerState getServerState () const
 The current state of the server.
 
void setServerId (const UaString &serverId)
 The Id of the server (not the URI).
 
void setServiceLevel (OpcUa_Byte serviceLevel)
 The service level of the server.
 
void setServerState (OpcUa_ServerState serverState)
 The current state of the server.
 

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.

Contains elements that describe the status of the Server.

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 to an existing OpcUa_RedundantServerDataType structure.

Don't manually free the attached structure afterwards, because UaRedundantServerDataType is responsible for it now.

Parameters
pValue[in] Parameter 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
pointer to a newly allocated OpcUa_RedundantServerDataType.
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
pointer 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 freeing the RedundantServerDataType data. If more than one reference exists, the data is copied to pDst instead of being detached.

Parameters
pDst[out] Pointer to an OpcUa_RedundantServerDataType structure that receives the RedundantServerDataType data.
Returns
If the function succeeds, pDst is returned, otherwise 0 is returned.
bool UaRedundantServerDataType::operator!= ( const UaRedundantServerDataType other) const

Compare two UaRedundantServerDataType for inequality.

See also
operator==
Parameters
otherthe UaRedundantServerDataType to compare with.
Returns
true if not equal, false otherwise.
UaRedundantServerDataType & UaRedundantServerDataType::operator= ( const UaRedundantServerDataType other)

Assignment operator.

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

Compare two UaRedundantServerDataType for equality.

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

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