.NET Based OPC UA Client/Server SDK  3.3.3.537
UnifiedAutomation.UaBase.DataValue Class Reference

The value of an attribute return from a server. More...

Inherits IFormattable, and ICloneable.

Public Member Functions

 DataValue ()
 Initializes a new instance of the DataValue class. More...
 
 DataValue (Variant value)
 Initializes a new instance of the DataValue class. More...
 
 DataValue (Variant value, DateTime sourceTimestamp)
 Initializes a new instance of the DataValue class. More...
 
 DataValue (StatusCode statusCode)
 Initializes a new instance of the DataValue class. More...
 
void ApplyTimestampFilter (TimestampsToReturn timestampsToReturn)
 Applies the timestamp filter. More...
 
override bool Equals (object obj)
 Determines if the specified object is equal to the object. More...
 
override int GetHashCode ()
 Returns a unique hash code for the object. More...
 
GetValue< T > (T defaultValue)
 Gets the value there is no error and it is the correct type. More...
 
object Clone ()
 Creates a deep copy of the object. 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...
 

Properties

object Value [get, set]
 Gets or sets the value within the WrappedValue. More...
 
Variant WrappedValue [get, set]
 Gets or sets the value. More...
 
StatusCode StatusCode [get, set]
 Gets or sets the status code associated with the value. More...
 
DateTime SourceTimestamp [get, set]
 Gets or sets the source timestamp. More...
 
ushort SourcePicoseconds [get, set]
 Gets or sets the source picoseconds. More...
 
DateTime ServerTimestamp [get, set]
 Gets or sets the server timestamp. More...
 
ushort ServerPicoseconds [get, set]
 Gets or sets the server picoseconds. More...
 

Detailed Description

The value of an attribute return from a server.

Constructor & Destructor Documentation

UnifiedAutomation.UaBase.DataValue.DataValue ( )

Initializes a new instance of the DataValue class.

UnifiedAutomation.UaBase.DataValue.DataValue ( Variant  value)

Initializes a new instance of the DataValue class.

Parameters
valueThe value.

This constructor sets the ServerTimestamp to UtcNow. Recommend using the new DataValue() { WrappedValue = value } form if this is not desired.

UnifiedAutomation.UaBase.DataValue.DataValue ( Variant  value,
DateTime  sourceTimestamp 
)

Initializes a new instance of the DataValue class.

Parameters
valueThe value.
sourceTimestampThe source timestamp.

This constructor sets the ServerTimestamp to UtcNow. Recommend using the new DataValue() { WrappedValue = value, SourceTimestamp = sourceTimestamp } form if this is not desired.

UnifiedAutomation.UaBase.DataValue.DataValue ( StatusCode  statusCode)

Initializes a new instance of the DataValue class.

Parameters
statusCodeThe status code.

This constructor sets the ServerTimestamp to UtcNow. Recommend using the new DataValue() { StatusCode = statusCode } form if this is not desired.

Member Function Documentation

void UnifiedAutomation.UaBase.DataValue.ApplyTimestampFilter ( TimestampsToReturn  timestampsToReturn)

Applies the timestamp filter.

Parameters
timestampsToReturnThe timestamps to return.
object UnifiedAutomation.UaBase.DataValue.Clone ( )

Creates a deep copy of the object.

override bool UnifiedAutomation.UaBase.DataValue.Equals ( object  obj)

Determines if the specified object is equal to the object.

Parameters
objThe object to compare to this
string UnifiedAutomation.UaBase.DataValue.Format ( )

Formats a node id as a string.

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

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

override int UnifiedAutomation.UaBase.DataValue.GetHashCode ( )

Returns a unique hash code for the object.

T UnifiedAutomation.UaBase.DataValue.GetValue< T > ( defaultValue)

Gets the value there is no error and it is the correct type.

Template Parameters
TThe type of value to return.
Parameters
defaultValueThe default value.
Returns
The value unless the StatusCode is Bad or the value is not of the specified type. The defaultValue is returned on error.
override string UnifiedAutomation.UaBase.DataValue.ToString ( )

Formats the object as a string.

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

Formats the object as a string.

Property Documentation

ushort UnifiedAutomation.UaBase.DataValue.ServerPicoseconds
getset

Gets or sets the server picoseconds.

The server picoseconds.

DateTime UnifiedAutomation.UaBase.DataValue.ServerTimestamp
getset

Gets or sets the server timestamp.

The server timestamp.

ushort UnifiedAutomation.UaBase.DataValue.SourcePicoseconds
getset

Gets or sets the source picoseconds.

The source picoseconds.

DateTime UnifiedAutomation.UaBase.DataValue.SourceTimestamp
getset

Gets or sets the source timestamp.

The source timestamp.

StatusCode UnifiedAutomation.UaBase.DataValue.StatusCode
getset

Gets or sets the status code associated with the value.

The status code.

object UnifiedAutomation.UaBase.DataValue.Value
getset

Gets or sets the value within the WrappedValue.

The value.

Variant UnifiedAutomation.UaBase.DataValue.WrappedValue
getset

Gets or sets the value.

The value.


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