.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaBase.StatusCode Struct Reference

Represents a status code. More...

Inherits IComparable, and IFormattable.

Public Member Functions

 StatusCode (uint code, string symbolicId, string namespaceUri, LocalizedText localizedText, string additionalInfo, StatusCode innerStatus)
 Initializes a new instance of the StatusCode class. More...
 
 StatusCode (uint code)
 Initializes a new instance of the StatusCode class. More...
 
 StatusCode (Exception e)
 Initializes a new instance of the StatusCode class. More...
 
 StatusCode (Exception e, uint defaultCode, string message, params object[] args)
 Initializes a new instance of the StatusCode class. More...
 
 StatusCode (uint code, string message, params object[] args)
 Initializes a new instance of the StatusCode class. More...
 
 StatusCode (StatusCode status, StatusCode innerStatus)
 Creates a StatusCode that contains a nested StatusCode. Flattened returns a flat list of all nested StatusCodes More...
 
 StatusCode (StatusCode code, int index, IList< DiagnosticInfo > diagnosticInfos, IList< string > strings)
 Initializes a new instance of the StatusCode class. More...
 
 StatusCode (StatusCode code, DiagnosticInfo diagnosticInfo, IList< string > strings)
 Initializes a new instance of the StatusCode class. More...
 
 StatusCode (uint code, Diagnostics diagnostics)
 Initializes a new instance of the StatusCode class. More...
 
StatusCode SetCodeBits (uint bits)
 Returns a copy of the status code with the Code bits set. More...
 
StatusCode SetStructureChanged (bool structureChanged)
 Returns a copy of the status code with the StructureChanged bit set. More...
 
StatusCode SetSemanticsChanged (bool semanticsChanged)
 Returns a copy of the status code with the SemanticsChanged bit set. More...
 
StatusCode SetHasDataValueInfo (bool hasDataValueInfo)
 Returns a copy of the status code with the DataValueInfo bit set. More...
 
StatusCode SetLimitBits (LimitBits bits)
 Returns a copy of the status code with the limit bits set. More...
 
StatusCode SetOverflow (bool overflow)
 Returns a copy of the status code with the overflow bit set. More...
 
StatusCode SetAggregateBits (AggregateBits bits)
 Returns a copy of the status code with the aggregate bits set. More...
 
bool IsBad ()
 Returns a flag indicating whether the status code is bad. More...
 
bool IsGood ()
 Returns a flag indicating whether the status code is good. More...
 
bool IsUncertain ()
 Returns a flag indicating whether the status code is uncertain. More...
 
override bool Equals (object obj)
 Returns true if the object is equal to the instance. More...
 
override int GetHashCode ()
 Returns a hash code for the instance. More...
 
int CompareTo (object obj)
 Compares the instance to another object. More...
 
string ToString (bool includeDiagnostics)
 Formats the object as a string. More...
 
override string ToString ()
 Formats the object as a string. More...
 
string ToString (string format, IFormatProvider formatProvider)
 Formats the object as a string. More...
 
string Format ()
 Formats a node id as a string. More...
 
void Format (StringBuilder buffer)
 Formats the node ids as string and adds it to the buffer. More...
 
string GetCodeName ()
 Returns a text representation of the code. More...
 

Static Public Member Functions

static bool IsBad (StatusCode statusCode)
 Determines whether the specified status code is bad. More...
 
static bool IsBad (uint code)
 Determines whether the specified code is bad. More...
 
static bool IsNotBad (StatusCode statusCode)
 Determines whether the specified status code is not bad. More...
 
static bool IsNotBad (uint code)
 Determines whether the specified status code is not bad. More...
 
static bool IsUncertain (StatusCode statusCode)
 Determines whether the specified status code is uncertain. More...
 
static bool IsUncertain (uint code)
 Determines whether the specified code is uncertain. More...
 
static bool IsNotUncertain (StatusCode statusCode)
 Determines whether the specified status code is not uncertain. More...
 
static bool IsNotUncertain (uint code)
 Determines whether the specified status code is not uncertain. More...
 
static bool IsGood (StatusCode statusCode)
 Determines whether the specified status code is good. More...
 
static bool IsGood (uint code)
 Determines whether the specified code is good. More...
 
static bool IsNotGood (StatusCode statusCode)
 Determines whether the specified status code is not good. More...
 
static bool IsNotGood (uint code)
 Determines whether the specified status code is not good. More...
 
static implicit operator StatusCode (uint code)
 Performs an implicit conversion from System.UInt32 to UnifiedAutomation.UaBase.StatusCode. More...
 
static bool operator== (StatusCode code1, StatusCode code2)
 Implements the operator ==. More...
 
static bool operator!= (StatusCode code1, StatusCode code2)
 Implements the operator !=. More...
 
static bool operator== (StatusCode code1, uint code2)
 Implements the operator ==. More...
 
static bool operator!= (StatusCode code1, uint code2)
 Implements the operator !=. More...
 

Properties

uint Code [get, set]
 Gets the numeric status code. More...
 
Diagnostics Diagnostics [get]
 Gets the diagnostics. More...
 
string Message [get]
 Gets the message based on the contents of the StatusCode object. More...
 
List< StatusCodeFlattened [get]
 Gets current and all nested StatusCodes.
 
uint CodeBits [get]
 Gets the code bits. More...
 
uint InfoBits [get]
 Gets the info bits. More...
 
bool StructureChanged [get]
 Set to indicate that the structure of the data value has changed. More...
 
bool SemanticsChanged [get]
 Set to indicate that the semantics associated with the data value have changed. More...
 
bool HasDataValueInfo [get]
 The bits that indicate the meaning of the status code More...
 
LimitBits LimitBits [get]
 The limit bits, indicating Hi/Lo etc. More...
 
bool Overflow [get]
 The overflow bit. More...
 
AggregateBits AggregateBits [get]
 The historian bits. More...
 

Detailed Description

Represents a status code.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.StatusCode.StatusCode ( uint  code,
string  symbolicId,
string  namespaceUri,
LocalizedText  localizedText,
string  additionalInfo,
StatusCode  innerStatus 
)

Initializes a new instance of the StatusCode class.

Parameters
codeThe code.
symbolicIdThe symbolic id.
namespaceUriThe namespace URI.
localizedTextThe localized text.
additionalInfoThe additional info.
innerStatusThe inner status.
UnifiedAutomation.UaBase.StatusCode.StatusCode ( uint  code)

Initializes a new instance of the StatusCode class.

Parameters
codeThe code.
UnifiedAutomation.UaBase.StatusCode.StatusCode ( Exception  e)

Initializes a new instance of the StatusCode class.

Parameters
eThe e.
UnifiedAutomation.UaBase.StatusCode.StatusCode ( Exception  e,
uint  defaultCode,
string  message,
params object[]  args 
)

Initializes a new instance of the StatusCode class.

Parameters
eThe e.
defaultCodeThe default code.
messageThe message.
argsThe args.
UnifiedAutomation.UaBase.StatusCode.StatusCode ( uint  code,
string  message,
params object[]  args 
)

Initializes a new instance of the StatusCode class.

Parameters
codeThe code.
messageThe message.
argsThe args.
UnifiedAutomation.UaBase.StatusCode.StatusCode ( StatusCode  status,
StatusCode  innerStatus 
)

Creates a StatusCode that contains a nested StatusCode. Flattened returns a flat list of all nested StatusCodes

Parameters
status
innerStatus
UnifiedAutomation.UaBase.StatusCode.StatusCode ( StatusCode  code,
int  index,
IList< DiagnosticInfo diagnosticInfos,
IList< string >  strings 
)

Initializes a new instance of the StatusCode class.

Parameters
codeThe code.
indexThe index.
diagnosticInfosThe diagnostic infos.
stringsThe strings.
UnifiedAutomation.UaBase.StatusCode.StatusCode ( StatusCode  code,
DiagnosticInfo  diagnosticInfo,
IList< string >  strings 
)

Initializes a new instance of the StatusCode class.

Parameters
codeThe code.
diagnosticInfoThe diagnostic info.
stringsThe strings.
UnifiedAutomation.UaBase.StatusCode.StatusCode ( uint  code,
Diagnostics  diagnostics 
)

Initializes a new instance of the StatusCode class.

Parameters
codeThe code.
diagnosticsThe diagnostics.

Member Function Documentation

int UnifiedAutomation.UaBase.StatusCode.CompareTo ( object  obj)

Compares the instance to another object.

Parameters
objThe object to compare to this object
override bool UnifiedAutomation.UaBase.StatusCode.Equals ( object  obj)

Returns true if the object is equal to the instance.

string UnifiedAutomation.UaBase.StatusCode.Format ( )

Formats a node id as a string.

void UnifiedAutomation.UaBase.StatusCode.Format ( StringBuilder  buffer)

Formats the node ids as string and adds it to the buffer.

string UnifiedAutomation.UaBase.StatusCode.GetCodeName ( )

Returns a text representation of the code.

override int UnifiedAutomation.UaBase.StatusCode.GetHashCode ( )

Returns a hash code for the instance.

bool UnifiedAutomation.UaBase.StatusCode.IsBad ( )

Returns a flag indicating whether the status code is bad.

static bool UnifiedAutomation.UaBase.StatusCode.IsBad ( StatusCode  statusCode)
static

Determines whether the specified status code is bad.

Parameters
statusCodeThe status code.
Returns
true if the specified status code is bad; otherwise, false.
static bool UnifiedAutomation.UaBase.StatusCode.IsBad ( uint  code)
static

Determines whether the specified code is bad.

Parameters
codeThe code.
Returns
true if the specified code is bad; otherwise, false.
bool UnifiedAutomation.UaBase.StatusCode.IsGood ( )

Returns a flag indicating whether the status code is good.

static bool UnifiedAutomation.UaBase.StatusCode.IsGood ( StatusCode  statusCode)
static

Determines whether the specified status code is good.

Parameters
statusCodeThe status code.
Returns
true if the specified status code is good; otherwise, false.
static bool UnifiedAutomation.UaBase.StatusCode.IsGood ( uint  code)
static

Determines whether the specified code is good.

Parameters
codeThe code.
Returns
true if the specified code is good; otherwise, false.
static bool UnifiedAutomation.UaBase.StatusCode.IsNotBad ( StatusCode  statusCode)
static

Determines whether the specified status code is not bad.

Parameters
statusCodeThe status code.
Returns
true if the specified status code is not bad; otherwise, false.
static bool UnifiedAutomation.UaBase.StatusCode.IsNotBad ( uint  code)
static

Determines whether the specified status code is not bad.

Parameters
codeThe code.
Returns
true if the specified status code is not bad; otherwise, false.
static bool UnifiedAutomation.UaBase.StatusCode.IsNotGood ( StatusCode  statusCode)
static

Determines whether the specified status code is not good.

Parameters
statusCodeThe status code.
Returns
true if the specified status code is not good; otherwise, false.
static bool UnifiedAutomation.UaBase.StatusCode.IsNotGood ( uint  code)
static

Determines whether the specified status code is not good.

Parameters
codeThe code.
Returns
true if the specified status code is not good; otherwise, false.
static bool UnifiedAutomation.UaBase.StatusCode.IsNotUncertain ( StatusCode  statusCode)
static

Determines whether the specified status code is not uncertain.

Parameters
statusCodeThe status code.
Returns
true if the specified status code is not uncertain; otherwise, false.
static bool UnifiedAutomation.UaBase.StatusCode.IsNotUncertain ( uint  code)
static

Determines whether the specified status code is not uncertain.

Parameters
codeThe code.
Returns
true if the specified status code is not uncertain; otherwise, false.
bool UnifiedAutomation.UaBase.StatusCode.IsUncertain ( )

Returns a flag indicating whether the status code is uncertain.

static bool UnifiedAutomation.UaBase.StatusCode.IsUncertain ( StatusCode  statusCode)
static

Determines whether the specified status code is uncertain.

Parameters
statusCodeThe status code.
Returns
true if the specified status code is uncertain; otherwise, false.
static bool UnifiedAutomation.UaBase.StatusCode.IsUncertain ( uint  code)
static

Determines whether the specified code is uncertain.

Parameters
codeThe code.
Returns
true if the specified code is uncertain; otherwise, false.
static implicit UnifiedAutomation.UaBase.StatusCode.operator StatusCode ( uint  code)
static

Performs an implicit conversion from System.UInt32 to UnifiedAutomation.UaBase.StatusCode.

Parameters
codeThe code.
Returns
The result of the conversion.
static bool UnifiedAutomation.UaBase.StatusCode.operator!= ( StatusCode  code1,
StatusCode  code2 
)
static

Implements the operator !=.

Parameters
code1The code1.
code2The code2.
Returns
The result of the operator.
static bool UnifiedAutomation.UaBase.StatusCode.operator!= ( StatusCode  code1,
uint  code2 
)
static

Implements the operator !=.

Parameters
code1The code1.
code2The code2.
Returns
The result of the operator.
static bool UnifiedAutomation.UaBase.StatusCode.operator== ( StatusCode  code1,
StatusCode  code2 
)
static

Implements the operator ==.

Parameters
code1The code1.
code2The code2.
Returns
The result of the operator.
static bool UnifiedAutomation.UaBase.StatusCode.operator== ( StatusCode  code1,
uint  code2 
)
static

Implements the operator ==.

Parameters
code1The code1.
code2The code2.
Returns
The result of the operator.
StatusCode UnifiedAutomation.UaBase.StatusCode.SetAggregateBits ( AggregateBits  bits)

Returns a copy of the status code with the aggregate bits set.

Parameters
bitsThe bits to set.
Returns
The status code with the aggregate bits set to the specified values.
StatusCode UnifiedAutomation.UaBase.StatusCode.SetCodeBits ( uint  bits)

Returns a copy of the status code with the Code bits set.

Parameters
bitsThe value for the Code bits.
Returns
The status code with the Code bits set to the specified values.
StatusCode UnifiedAutomation.UaBase.StatusCode.SetHasDataValueInfo ( bool  hasDataValueInfo)

Returns a copy of the status code with the DataValueInfo bit set.

Parameters
hasDataValueInfoThe value for the DataValueInfo bit.
Returns
The status code with the DataValueInfo bit set to the specified value.
StatusCode UnifiedAutomation.UaBase.StatusCode.SetLimitBits ( LimitBits  bits)

Returns a copy of the status code with the limit bits set.

Parameters
bitsThe value for the limits bits
Returns
The status code with the limit bits set to the specified values.
StatusCode UnifiedAutomation.UaBase.StatusCode.SetOverflow ( bool  overflow)

Returns a copy of the status code with the overflow bit set.

Parameters
overflowThe value for the overflow bit.
Returns
The status code with the overflow bit set to the specified value.
StatusCode UnifiedAutomation.UaBase.StatusCode.SetSemanticsChanged ( bool  semanticsChanged)

Returns a copy of the status code with the SemanticsChanged bit set.

Parameters
semanticsChangedThe value for the SemanticsChanged bit.
Returns
The status code with the SemanticsChanged bit set to the specified value.
StatusCode UnifiedAutomation.UaBase.StatusCode.SetStructureChanged ( bool  structureChanged)

Returns a copy of the status code with the StructureChanged bit set.

Parameters
structureChangedThe value for the StructureChanged bit.
Returns
The status code with the StructureChanged bit set to the specified value.
string UnifiedAutomation.UaBase.StatusCode.ToString ( bool  includeDiagnostics)

Formats the object as a string.

override string UnifiedAutomation.UaBase.StatusCode.ToString ( )

Formats the object as a string.

string UnifiedAutomation.UaBase.StatusCode.ToString ( string  format,
IFormatProvider  formatProvider 
)

Formats the object as a string.

Property Documentation

AggregateBits UnifiedAutomation.UaBase.StatusCode.AggregateBits
get

The historian bits.

See also
AggregateBits
uint UnifiedAutomation.UaBase.StatusCode.Code
getset

Gets the numeric status code.

The numeric status code.

uint UnifiedAutomation.UaBase.StatusCode.CodeBits
get

Gets the code bits.

Diagnostics UnifiedAutomation.UaBase.StatusCode.Diagnostics
get

Gets the diagnostics.

The diagnostics.

bool UnifiedAutomation.UaBase.StatusCode.HasDataValueInfo
get

The bits that indicate the meaning of the status code

uint UnifiedAutomation.UaBase.StatusCode.InfoBits
get

Gets the info bits.

LimitBits UnifiedAutomation.UaBase.StatusCode.LimitBits
get

The limit bits, indicating Hi/Lo etc.

See also
LimitBits
string UnifiedAutomation.UaBase.StatusCode.Message
get

Gets the message based on the contents of the StatusCode object.

bool UnifiedAutomation.UaBase.StatusCode.Overflow
get

The overflow bit.

bool UnifiedAutomation.UaBase.StatusCode.SemanticsChanged
get

Set to indicate that the semantics associated with the data value have changed.

bool UnifiedAutomation.UaBase.StatusCode.StructureChanged
get

Set to indicate that the structure of the data value has changed.


The documentation for this struct was generated from the following file: