UaStatus Class Reference [UA Base Library Classes]

The class UaStatus handles status codes, conversions of the status code and diagnostic information. Der ived from UaStatusCode. More...

#include <statuscode.h>

Inheritance diagram for UaStatus:

Collaboration diagram for UaStatus:

List of all members.

Public Member Functions
	UaStatus ()
	UaStatus (const OpcUa_StatusCode &other)
	UaStatus (const UaStatusCode &other)
	UaStatus (const UaStatus &other)
	~UaStatus ()
UaStatus &	operator= (const OpcUa_StatusCode &other)
UaStatus &	operator= (const UaStatusCode &other)
UaStatus &	operator= (const UaStatus &other)
void	setStatus (OpcUa_StatusCode statusCode, const UaString &sDiagnosticInfo)
void	setDiagnostigInfo (const UaQualifiedName &symbolicId, const UaLocalizedText &diagnosticInfo)
void	setDiagnostigInfo (OpcUa_UInt16 namespaceIndex, OpcUa_UInt32 numericReturnCode, const UaLocalizedText &diagnosticInfo)
void	setAdditionalInfo (const UaString &sAdditionalInfo)
Protected Attributes
UaDiagnosticInfo *	m_pDiagnosticInfo
	Membervar.

---

Detailed Description

The class UaStatus handles status codes, conversions of the status code and diagnostic information. Der ived from UaStatusCode.

UaStatus

---

Constructor & Destructor Documentation

UaStatus::UaStatus

(

)

Constructs a status with empty diagnostic info and status code set to Good

UaStatus::UaStatus

(

const OpcUa_StatusCode &

other )

Constructs a status with empty diagnostic info and the passed status code

Parameters:

other

the status code as OpcUa_StatusCode.

UaStatus::UaStatus

(

const UaStatusCode &

other )

Constructs a status with empty diagnostic info and the passed status code

Parameters:

other

the status code as UaStatusCode.

UaStatus::UaStatus

(

const UaStatus &

other )

Constructs a status with another UaStatus

Parameters:

other

the other status as UaStatus.

UaStatus::~UaStatus

(

)

Destroys the status

---

Member Function Documentation

UaStatus & UaStatus::operator=

(

const OpcUa_StatusCode &

other )

Assigns other status code to this status, resets the diagnostic information and returns a reference to this status

Parameters:

other

the status code to assign as OpcUa_StatusCode

Returns:

The reference to the changes status

Reimplemented from UaStatusCode.

UaStatus & UaStatus::operator=

(

const UaStatusCode &

other )

Assigns other status code to this status, resets the diagnostic information and returns a reference to this status

Parameters:

other

the status code to assign as UaStatusCode

Returns:

The reference to the changes status

Reimplemented from UaStatusCode.

UaStatus & UaStatus::operator=

(

const UaStatus &

other )

Assigns other status to this status and returns a reference to this status

Parameters:

other

the other UaStatus to assign.

Returns:

The reference to the changes status

void UaStatus::setAdditionalInfo

(

const UaString &

sAdditionalInfo )

Set the string for additional vendor specific diagnostic information.

Parameters:

sAdditionalInfo

the additional dignostic information.

void UaStatus::setDiagnostigInfo	(	OpcUa_UInt16	namespaceIndex,
		OpcUa_UInt32	numericReturnCode,
		const UaLocalizedText &	diagnosticInfo
	)

Set a numeric return code and a diagnostic info.

Parameters:

namespaceIndex	The namespace index used together with the numericReturnCode to compose the SymbolicId.
numericReturnCode	A numeric return code that gets converted into a string used as SymbolicId in the diagnostic information.
diagnosticInfo	An optional vendor-specific localized text string describíng the error condition related to the numeric code. The maximum length of this text string is 256 characters..

void UaStatus::setDiagnostigInfo	(	const UaQualifiedName &	symbolicId,
		const UaLocalizedText &	diagnosticInfo
	)

Set a symbolicId and a diagnostic info string used to provide diagnostig information.

Parameters:

symbolicId	The symbolic Id as UaQualifiedName. A vendor-specific symbolic identifier string identifies an error or condition. The maximum length of this string is 32 characters. Servers wishing to return a numeric return code should convert the return code into a string and return the string in this identifier. The UaStatus class provides another overloaded member to pass a numeric code.
diagnosticInfo	An optional vendor-specific localized text string describíng the error condition related to the symbolic id. The maximum length of this text string is 256 characters.

void UaStatus::setStatus	(	OpcUa_StatusCode	statusCode,
		const UaString &	sDiagnosticInfo
	)

Set a status code and a diagnostic info.

Parameters:

statusCode	the OPC UA Status code
sDiagnosticInfo	An optional vendor-specific localized text string describíng the error condition. The maximum length of this text string is 256 characters..

---

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

• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/statuscode.h
• /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/statuscode.cpp