C++ Based OPC UA Client/Server SDK  1.5.5.355
UaProgramDiagnosticDataType Class Reference

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

#include <uaprogramdiagnosticdatatype.h>

Public Member Functions

 UaProgramDiagnosticDataType ()
 Constructs an instance of the class UaProgramDiagnosticDataType with empty default values.
 
 UaProgramDiagnosticDataType (const UaProgramDiagnosticDataType &other)
 Constructs an instance of the class UaProgramDiagnosticDataType with values from another UaProgramDiagnosticDataType object. More...
 
 UaProgramDiagnosticDataType (const OpcUa_ProgramDiagnosticDataType &other)
 Constructs an instance of the class UaProgramDiagnosticDataType with values from another OpcUa_ProgramDiagnosticDataType structure. More...
 
 UaProgramDiagnosticDataType (const UaNodeId &createSessionId, const UaString &createClientName, const UaDateTime &invocationCreationTime, const UaDateTime &lastTransitionTime, const UaString &lastMethodCall, const UaNodeId &lastMethodSessionId, const UaArguments &lastMethodInputArguments, const UaArguments &lastMethodOutputArguments, const UaDateTime &lastMethodCallTime, const UaStatus &lastMethodReturnStatus)
 Constructs an instance of the class UaProgramDiagnosticDataType with values provided in the constructor.
 
 UaProgramDiagnosticDataType (const UaExtensionObject &extensionObject)
 Constructs an instance of the class UaProgramDiagnosticDataType initialized with value from a UaExtensionObject. More...
 
 UaProgramDiagnosticDataType (const OpcUa_ExtensionObject &extensionObject)
 Constructs an instance of the class UaProgramDiagnosticDataType initialized with value from an OpcUa_ExtensionObject structure. More...
 
 ~UaProgramDiagnosticDataType ()
 Destroys the UaProgramDiagnosticDataType object.
 
void clear ()
 Clear the data of the UaProgramDiagnosticDataType. More...
 
bool operator== (const UaProgramDiagnosticDataType &other) const
 Compare two UaProgramDiagnosticDataType for equality. More...
 
bool operator!= (const UaProgramDiagnosticDataType &other) const
 Compare two UaProgramDiagnosticDataType for inequality. More...
 
UaProgramDiagnosticDataTypeoperator= (const UaProgramDiagnosticDataType &other)
 Assignment operator. More...
 
OpcUa_ProgramDiagnosticDataType * copy () const
 Copy UaProgramDiagnosticDataType data to a newly allocated OpcUa_ProgramDiagnosticDataType. More...
 
void copyTo (OpcUa_ProgramDiagnosticDataType *pDst) const
 Copy UaProgramDiagnosticDataType data to an existing OpcUa_ProgramDiagnosticDataType structure. More...
 
void attach (OpcUa_ProgramDiagnosticDataType *pValue)
 Attaches to an existing OpcUa_ProgramDiagnosticDataType structure. More...
 
OpcUa_ProgramDiagnosticDataType * detach (OpcUa_ProgramDiagnosticDataType *pDst)
 Detaches the internal ProgramDiagnosticDataType structure from this class. More...
 
UaNodeId getCreateSessionId () const
 Returns the CreateSessionId.
 
UaString getCreateClientName () const
 Returns the CreateClientName.
 
UaDateTime getInvocationCreationTime () const
 Returns the InvocationCreationTime.
 
UaDateTime getLastTransitionTime () const
 Returns the LastTransitionTime.
 
UaString getLastMethodCall () const
 Returns the LastMethodCall.
 
UaNodeId getLastMethodSessionId () const
 Returns the LastMethodSessionId.
 
void getLastMethodInputArguments (UaArguments &lastMethodInputArguments) const
 Returns the LastMethodInputArguments.
 
void getLastMethodOutputArguments (UaArguments &lastMethodOutputArguments) const
 Returns the LastMethodOutputArguments.
 
UaDateTime getLastMethodCallTime () const
 Returns the LastMethodCallTime.
 
UaStatus getLastMethodReturnStatus () const
 Returns the LastMethodReturnStatus.
 
void setCreateSessionId (const UaNodeId &createSessionId)
 Sets the CreateSessionId.
 
void setCreateClientName (const UaString &createClientName)
 Sets the CreateClientName.
 
void setInvocationCreationTime (const UaDateTime &invocationCreationTime)
 Sets the InvocationCreationTime.
 
void setLastTransitionTime (const UaDateTime &lastTransitionTime)
 Sets the LastTransitionTime.
 
void setLastMethodCall (const UaString &lastMethodCall)
 Sets the LastMethodCall.
 
void setLastMethodSessionId (const UaNodeId &lastMethodSessionId)
 Sets the LastMethodSessionId.
 
void setLastMethodInputArguments (const UaArguments &lastMethodInputArguments)
 Sets the LastMethodInputArguments.
 
void setLastMethodOutputArguments (const UaArguments &lastMethodOutputArguments)
 Sets the LastMethodOutputArguments.
 
void setLastMethodCallTime (const UaDateTime &lastMethodCallTime)
 Sets the LastMethodCallTime.
 
void setLastMethodReturnStatus (const UaStatus &lastMethodReturnStatus)
 Sets the LastMethodReturnStatus.
 

Static Public Member Functions

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

Detailed Description

Wrapper class for the UA stack structure OpcUa_ProgramDiagnosticDataType.

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

Constructor & Destructor Documentation

UaProgramDiagnosticDataType::UaProgramDiagnosticDataType ( const UaProgramDiagnosticDataType other)

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

Parameters
otherthe other UaProgramDiagnosticDataType used to initialize the object
UaProgramDiagnosticDataType::UaProgramDiagnosticDataType ( const OpcUa_ProgramDiagnosticDataType &  other)

Constructs an instance of the class UaProgramDiagnosticDataType with values from another OpcUa_ProgramDiagnosticDataType structure.

Parameters
otherthe other OpcUa_ProgramDiagnosticDataType used to initialize the object
UaProgramDiagnosticDataType::UaProgramDiagnosticDataType ( const UaExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the ProgramDiagnosticDataType
UaProgramDiagnosticDataType::UaProgramDiagnosticDataType ( const OpcUa_ExtensionObject extensionObject)

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

Parameters
extensionObjectthe extension object containing the ProgramDiagnosticDataType

Member Function Documentation

void UaProgramDiagnosticDataType::attach ( OpcUa_ProgramDiagnosticDataType *  pValue)

Attaches to an existing OpcUa_ProgramDiagnosticDataType structure.

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

Parameters
pValue[in] Parameter to attach to.
void UaProgramDiagnosticDataType::clear ( )

Clear the data of the UaProgramDiagnosticDataType.

OpcUa_ProgramDiagnosticDataType * UaProgramDiagnosticDataType::clone ( const OpcUa_ProgramDiagnosticDataType &  source)
static

Copy OpcUa_ProgramDiagnosticDataType data to a newly allocated OpcUa_ProgramDiagnosticDataType.

Parameters
sourceSource to clone.
Returns
pointer to a newly allocated OpcUa_ProgramDiagnosticDataType.
void UaProgramDiagnosticDataType::cloneTo ( const OpcUa_ProgramDiagnosticDataType &  source,
OpcUa_ProgramDiagnosticDataType &  copy 
)
static

Copy OpcUa_ProgramDiagnosticDataType data to an existing OpcUa_ProgramDiagnosticDataType structure.

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

Copy UaProgramDiagnosticDataType data to a newly allocated OpcUa_ProgramDiagnosticDataType.

Returns
pointer to a newly allocated OpcUa_ProgramDiagnosticDataType.
void UaProgramDiagnosticDataType::copyTo ( OpcUa_ProgramDiagnosticDataType *  pDst) const

Copy UaProgramDiagnosticDataType data to an existing OpcUa_ProgramDiagnosticDataType structure.

Parameters
pDstthe destination of this copy operation.
OpcUa_ProgramDiagnosticDataType * UaProgramDiagnosticDataType::detach ( OpcUa_ProgramDiagnosticDataType *  pDst)

Detaches the internal ProgramDiagnosticDataType structure from this class.

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

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

Compare two UaProgramDiagnosticDataType for inequality.

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

Assignment operator.

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

Compare two UaProgramDiagnosticDataType for equality.

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

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