.NET Based OPC UA Client/Server SDK
3.1.3.516
|
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 llimit 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< StatusCode > | Flattened [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... | |
Represents a status code.
UnifiedAutomation.UaBase.StatusCode.StatusCode | ( | uint | code, |
string | symbolicId, | ||
string | namespaceUri, | ||
LocalizedText | localizedText, | ||
string | additionalInfo, | ||
StatusCode | innerStatus | ||
) |
Initializes a new instance of the StatusCode class.
code | The code. |
symbolicId | The symbolic id. |
namespaceUri | The namespace URI. |
localizedText | The localized text. |
additionalInfo | The additional info. |
innerStatus | The inner status. |
UnifiedAutomation.UaBase.StatusCode.StatusCode | ( | uint | code | ) |
Initializes a new instance of the StatusCode class.
code | The code. |
UnifiedAutomation.UaBase.StatusCode.StatusCode | ( | Exception | e | ) |
Initializes a new instance of the StatusCode class.
e | The e. |
UnifiedAutomation.UaBase.StatusCode.StatusCode | ( | Exception | e, |
uint | defaultCode, | ||
string | message, | ||
params object[] | args | ||
) |
Initializes a new instance of the StatusCode class.
e | The e. |
defaultCode | The default code. |
message | The message. |
args | The args. |
UnifiedAutomation.UaBase.StatusCode.StatusCode | ( | uint | code, |
string | message, | ||
params object[] | args | ||
) |
Initializes a new instance of the StatusCode class.
code | The code. |
message | The message. |
args | The 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
status | |
innerStatus |
UnifiedAutomation.UaBase.StatusCode.StatusCode | ( | StatusCode | code, |
int | index, | ||
IList< DiagnosticInfo > | diagnosticInfos, | ||
IList< string > | strings | ||
) |
Initializes a new instance of the StatusCode class.
code | The code. |
index | The index. |
diagnosticInfos | The diagnostic infos. |
strings | The strings. |
UnifiedAutomation.UaBase.StatusCode.StatusCode | ( | StatusCode | code, |
DiagnosticInfo | diagnosticInfo, | ||
IList< string > | strings | ||
) |
Initializes a new instance of the StatusCode class.
code | The code. |
diagnosticInfo | The diagnostic info. |
strings | The strings. |
UnifiedAutomation.UaBase.StatusCode.StatusCode | ( | uint | code, |
Diagnostics | diagnostics | ||
) |
Initializes a new instance of the StatusCode class.
code | The code. |
diagnostics | The diagnostics. |
int UnifiedAutomation.UaBase.StatusCode.CompareTo | ( | object | obj | ) |
Compares the instance to another object.
obj | The 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 |
Determines whether the specified status code is bad.
statusCode | The status code. |
true
if the specified status code is bad; otherwise, false
.
|
static |
Determines whether the specified code is bad.
code | The code. |
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 |
Determines whether the specified status code is good.
statusCode | The status code. |
true
if the specified status code is good; otherwise, false
.
|
static |
Determines whether the specified code is good.
code | The code. |
true
if the specified code is good; otherwise, false
.
|
static |
Determines whether the specified status code is not bad.
statusCode | The status code. |
true
if the specified status code is not bad; otherwise, false
.
|
static |
Determines whether the specified status code is not bad.
code | The code. |
true
if the specified status code is not bad; otherwise, false
.
|
static |
Determines whether the specified status code is not good.
statusCode | The status code. |
true
if the specified status code is not good; otherwise, false
.
|
static |
Determines whether the specified status code is not good.
code | The code. |
true
if the specified status code is not good; otherwise, false
.
|
static |
Determines whether the specified status code is not uncertain.
statusCode | The status code. |
true
if the specified status code is not uncertain; otherwise, false
.
|
static |
Determines whether the specified status code is not uncertain.
code | The code. |
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 |
Determines whether the specified status code is uncertain.
statusCode | The status code. |
true
if the specified status code is uncertain; otherwise, false
.
|
static |
Determines whether the specified code is uncertain.
code | The code. |
true
if the specified code is uncertain; otherwise, false
.
|
static |
Performs an implicit conversion from System.UInt32 to UnifiedAutomation.UaBase.StatusCode.
code | The code. |
|
static |
Implements the operator !=.
code1 | The code1. |
code2 | The code2. |
|
static |
Implements the operator !=.
code1 | The code1. |
code2 | The code2. |
|
static |
Implements the operator ==.
code1 | The code1. |
code2 | The code2. |
|
static |
Implements the operator ==.
code1 | The code1. |
code2 | The code2. |
StatusCode UnifiedAutomation.UaBase.StatusCode.SetAggregateBits | ( | AggregateBits | bits | ) |
Returns a copy of the status code with the aggregate bits set.
bits | The bits to set. |
StatusCode UnifiedAutomation.UaBase.StatusCode.SetCodeBits | ( | uint | bits | ) |
Returns a copy of the status code with the Code bits set.
bits | The value for the Code bits. |
StatusCode UnifiedAutomation.UaBase.StatusCode.SetHasDataValueInfo | ( | bool | hasDataValueInfo | ) |
Returns a copy of the status code with the DataValueInfo bit set.
hasDataValueInfo | The value for the DataValueInfo bit. |
StatusCode UnifiedAutomation.UaBase.StatusCode.SetLimitBits | ( | LimitBits | bits | ) |
Returns a copy of the status code with the llimit bits set.
bits | The value for the limits bits |
StatusCode UnifiedAutomation.UaBase.StatusCode.SetOverflow | ( | bool | overflow | ) |
Returns a copy of the status code with the overflow bit set.
overflow | The value for the overflow bit. |
StatusCode UnifiedAutomation.UaBase.StatusCode.SetSemanticsChanged | ( | bool | semanticsChanged | ) |
Returns a copy of the status code with the SemanticsChanged bit set.
semanticsChanged | The value for the SemanticsChanged bit. |
StatusCode UnifiedAutomation.UaBase.StatusCode.SetStructureChanged | ( | bool | structureChanged | ) |
Returns a copy of the status code with the StructureChanged bit set.
structureChanged | The value for the StructureChanged bit. |
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.
|
get |
The historian bits.
|
getset |
Gets the numeric status code.
The numeric status code.
|
get |
Gets the code bits.
|
get |
Gets the diagnostics.
The diagnostics.
|
get |
The bits that indicate the meaning of the status code
|
get |
Gets the info bits.
|
get |
The limit bits, indicating Hi/Lo etc.
|
get |
Gets the message based on the contents of the StatusCode object.
|
get |
The overflow bit.
|
get |
Set to indicate that the semantics associated with the data value have changed.
|
get |
Set to indicate that the structure of the data value has changed.