addPointValue
Prev DataHubConnector Methods Next

addPointValue

addPointValue — adds a specified amount to a DataHub point value.

Synopsis

For C++:
ST_STATUS addPointValue(point,  
 value); 
CDataHubPoint& point;
double value;
 
ST_STATUS addPointValue(pointname,  
 value); 
LPCTSTR pointname;
double value;
 
For Java and C#:
Exception addPointValue(point,  
 value); 
DataHubPoint point;
double value;
 
Exception addPointValue(pointname,  
 value); 
String pointname;
double value;
 

Parameters

point

A DataHubPoint object. The name, seconds and nanoseconds members must be valid.

pointname

The name of the point. The point timestamp is automatically set to the current time.

value

The value to add to the current point value.

Returns

For C++:

  • ST_OK if the command was successfully sent to the DataHub instance. Since the command is sent asynchronously, the actual success or failure of the command must be determined through the onSuccess or onError message handlers.

  • ST_NO_TASK if a connection to the DataHub instance does not exist.

  • ST_ERROR if the connection socket is unable to send the message.

Description

Adds the specified value to the current value of the DataHub point. If the DataHub point is not of a numeric type, then the DataHub instance will respond with an error, and onError will be called with the following arguments:

status: ST_WRONG_TYPE
msg: "Wrong type"

If the DataHub point does not exist, then the DataHub instance will respond with an error, and onError will be called with the following arguments:

status: ST_NO_POINT
msg: "Point does not exist"

Examples

addPointValue(_T("intPoint1"), 1.0);
CDataHubPoint point;
point.name = "realPoint2";
setPointTimeStamp (&point);
addPointValue(&point, 1.234);

See Also

appendPointValue, multiplyPointValue, dividePointValue, writePoint

Prev Up Next
activeHeartbeatTimers  Home  appendPointValue