UaStatusCode Class Reference [UA Base Library Classes]

The class encapsulated OPC UA status codes and conversions from ant to Classic OPC codes. More...

#include <statuscode.h>

Inheritance diagram for UaStatusCode:

List of all members.

Public Member Functions
	UaStatusCode ()
	UaStatusCode (const OpcUa_StatusCode &other)
	~UaStatusCode ()
UaStatusCode &	operator= (const OpcUa_StatusCode &other)
UaStatusCode &	operator= (const UaStatusCode &other)
OpcUa_Boolean	isGood () const
OpcUa_Boolean	isNotGood () const
OpcUa_Boolean	isUncertain () const
OpcUa_Boolean	isNotUncertain () const
OpcUa_Boolean	isBad () const
OpcUa_Boolean	isNotBad () const
OpcUa_StatusCode	statusCode () const
void	getResponseHeader (OpcUa_RequestHeader *requestHeader, OpcUa_ResponseHeader *responseHeader)
UaString	toString () const
Static Public Member Functions
static OpcUa_StatusCode	setComDaError (long comDaError)
static OpcUa_StatusCode	setComDaQuality (unsigned short comDaQuality)
static OpcUa_StatusCode	setComDaStatus (long comDaError, unsigned short comDaQuality)
static void	getComDaStatus (const OpcUa_StatusCode statusCode, long &comDaError, unsigned short &comDaQuality)

---

Detailed Description

The class encapsulated OPC UA status codes and conversions from ant to Classic OPC codes.

---

Constructor & Destructor Documentation

UaStatusCode::UaStatusCode

(

)

Construction of the status code class with initial value Good.

UaStatusCode::UaStatusCode

(

const OpcUa_StatusCode &

other )

Construction of the status code class with passed code as initial value

Parameters:

other

Initial status code value

UaStatusCode::~UaStatusCode

(

)

Destruction of status code class

---

Member Function Documentation

void UaStatusCode::getComDaStatus	(	const OpcUa_StatusCode	statusCode,
		long &	comDaError,
		unsigned short &	comDaQuality
	)		[static]

Get COM DA error and quality from the status code.

Parameters:

statusCode	the OPC UA Status code.
comDaError	a COM DA error.
comDaQuality	a COM DA quality.

void UaStatusCode::getResponseHeader	(	OpcUa_RequestHeader *	requestHeader,
		OpcUa_ResponseHeader *	responseHeader
	)

Creates a response header for OPC UA service calls.

Parameters:

requestHeader	the request header.
responseHeader	the response header.

OpcUa_Boolean UaStatusCode::isBad

(

)

const [inline]

Checks if the status code is BAD

OpcUa_Boolean UaStatusCode::isGood

(

)

const [inline]

Checks if the status code is GOOD

OpcUa_Boolean UaStatusCode::isNotBad

(

)

const [inline]

Checks if the status code is not BAD

OpcUa_Boolean UaStatusCode::isNotGood

(

)

const [inline]

Checks if the status code is not GOOD

OpcUa_Boolean UaStatusCode::isNotUncertain

(

)

const [inline]

Checks if the status code is not UNCERTAIN

OpcUa_Boolean UaStatusCode::isUncertain

(

)

const [inline]

Checks if the status code is UNCERTAIN

UaStatusCode & UaStatusCode::operator=

(

const UaStatusCode &

other )

Implements the operator = for UaStatusCode.

Parameters:

other

the UaStatusCode to assign.

Returns:

Assignment operator.

Reimplemented in UaStatus.

UaStatusCode & UaStatusCode::operator=

(

const OpcUa_StatusCode &

other )

Implements the operator = for UaStatusCode.

Parameters:

other

The OpcUa_StatusCode to assign.

Returns:

Assignment operator.

Reimplemented in UaStatus.

OpcUa_StatusCode UaStatusCode::setComDaError

(

long

comDaError )

[static]

Set the status code with a COM DA error code.

Parameters:

comDaError

a COM DA error code.

Returns:

the OPC UA Status Code

OpcUa_StatusCode UaStatusCode::setComDaQuality

(

unsigned short

comDaQuality )

[static]

Set the status code with a COM DA quality.

Parameters:

comDaQuality

a COM DA quality.

Returns:

the OPC UA Status Code

OpcUa_StatusCode UaStatusCode::setComDaStatus	(	long	comDaError,
		unsigned short	comDaQuality
	)		[static]

Set the status code with COM DA error and quality.

Parameters:

comDaError	a COM DA error.
comDaQuality	a COM DA quality.

Returns:

the OPC UA Status Code

OpcUa_StatusCode UaStatusCode::statusCode

(

)

const [inline]

Get the status code value

UaString UaStatusCode::toString

(

)

const

Returns the string representation of the current OPC UA status code.

Returns:

The symbolic name for the passed status code

---

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