Class Definitions

WriteItem Class

public class WriteItem
{
  public WriteItem(object value, string path);
  public string Path;
  public object Value;
  public Result Result;
}

Constructor:

public WriteItem(object value, string path);

Table 1. WriteItem Class Properties
Name	Description
Path	Symbolic path of the item
Result	Result of the write operation
Value	Value of the item

The following C# data types (as well as arrays of them) are allowed:

bool
byte
sbyte
Int32
UInt32
Int64
UInt64
double
string
DateTime

It is also allowed to provide null values. Both, arrays of null values and mixed arrays containing null values are also allowed.

ReadItem Class

public class ReadItem
{
  public ReadItem(string path);
  public string Path;
  public object Value;
  public long? QualityMask;
  public DateTime? Timestamp;
  public VqtChangeType VqtChangeType;
  public Result Result;
}

Constructor:

public ReadItem(string path);

Table 2. ReadItem Class Properties
Name	Description
Path	Symbolic name of the item
QualityMask	Numeric quality value (use the QualityHelper class to check it)
Result	Result of the read operation for this item
Timestamp	UTC timestamp of the item
Value	Value of the item
VqtChangeType	Effects on data change notifications (see OnDataChange event)

Result Class

public class Result
{
  public int Code;
  public string Message;
  public bool Succeeded();
  public bool Failed();
  public string ToString();
  public Result();
}

Constructor:

public Result();

Table 3. Result Class Properties
Name	Description
Code	Numeric representation of the result
Message	Textual representation of the result (language dependent)

Result Class Methods

TcpConfig Class

public class TcpConfig
{
  public int TcpClientSendTimeout = 1000;
  public int TcpClientReceiveTimeout = 1000;
  public int TcpConnectTimeout = 5000;
  public string HostNameOrIp = null;
  public int Port = 0;
}

Table 4. TcpConfig Class Properties
Name	Description
TcpClientSendTimeout	Timeout (ms) for sending data.
TcpClientReceiveTimeout	Timeout (ms) for reading data.
TcpConnectTimeout	Timeout (ms) for connecting server.
HostNameOrIp	Hostname or IP.
Port	Port number of the server.

Message Class

public class Message
{
  public ReadItem(string path);
  public string GetText(LANGUAGE? Language=null);
  public int GetCode();
}

Table 5. Message Class Methods
Name	Description
ReadItem	Object holding read parameters and value
GetText	Returns localized text of the message
GetCode	Returns message code

HistoryResponse Class

public class HistoryResponse
{
  publicObjectInfo GetResult(stringpath, HistoryAggregateTypeagg);
  publicIntervalData[] GetData(stringpath, HistoryAggregateTypeagg);
}

ObjectInfo Class

public class ObjectInfo
{
  publicstring Description;
  publicstring EngUnit;
  publicdouble LowLimit;
  publicdouble HighLimit;
  publicResult Result;
}

HistoricalDataItem Class

public class HistoricalDataItem
{
  public HistoricalDataItem(string path);
  public string Path;
  public HistoryAggregateType[] Aggregates;
}