DataHub APIs for C++, Java, and .NET : Version 6.4
	DataHubConnector Methods

`writePoint`

writePoint — writes a new value to a Cascade DataHub point.

Syntax

For C++:

ST_STATUS writePoint( CDataHubPoint&   point, 
  bool   create=TRUE, 
  int   force=FALSE);

ST_STATUS writePoint( LPCTSTR   pointname, 
  int   value, 
  bool   create=TRUE, 
  bool   force=FALSE);

ST_STATUS writePoint( LPCTSTR   pointname, 
  double   value, 
  bool   create=TRUE, 
  bool   force=FALSE);

ST_STATUS writePoint( LPCTSTR   pointname, 
  LPCTSTR   value, 
  bool   create=TRUE, 
  bool   force=FALSE);

For Java:

Exception writePoint( DataHubPoint   point, 
  boolean   create, 
  boolean   force);

Exception writePoint( String   pointname, 
  String   value, 
  boolean   create, 
  boolean   force);

Exception writePoint( String   pointname, 
  String   value);

Exception writePoint( String   pointname, 
  double   value, 
  boolean   create, 
  boolean   force);

Exception writePoint( String   pointname, 
  double   value);

Exception writePoint( String   pointname, 
  int   value, 
  boolean   create, 
  boolean   force);

Exception writePoint( String   pointname, 
  int   value);

Exception writePoint( String   pointname, 
  int   type, 
  String   value_as_string, 
  boolean   create, 
  boolean   force);

For C#:

Exception writePoint( DataHubPoint   point, 
  bool   create, 
  bool   force);

Exception writePoint( String   pointname, 
  String   value, 
  bool   create, 
  bool   force);

Exception writePoint( String   pointname, 
  String   value);

Exception writePoint( String   pointname, 
  double   value, 
  bool   create, 
  bool   force);

Exception writePoint( String   pointname, 
  double   value);

Exception writePoint( String   pointname, 
  int   value, 
  bool   create, 
  bool   force);

Exception writePoint( String   pointname, 
  int   value);

Exception writePoint( String   pointname, 
  int   type, 
  String   value_as_string, 
  bool   create, 
  bool   force);

Parameters

point: A DataHubPoint object. The name, type, value, seconds and nanoseconds members must be valid.
create: If TRUE, then the point is created if it does not already exist. If FALSE and the point does not exist, then an error message will be generated.
force: If a valid connection to the DataHub exists but the message is undeliverable immediately (due to the TCP buffer being full), then if the force parameter is TRUE, the message is queued and will be transmitted when possible.
pointname: The name of the point. The point timestamp is automatically set to the current time.
value: The integer, double, or string value to write to the point. The type of the point in the DataHub will be changed accordingly.

Returns

For C++:

ST_OK if the command was successfully sent to the DataHub. 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 does not exist.

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

Description

This method writes the given point to the DataHub. If a DataHubPoint is used, then the point name, type, value, quality and timestamp members must be set. If the point is specified by name, then the type is determined by the specific overloaded method and the timestamp is set to the current time.

If a domain name has been associated with the client (see setDefaultDomain), then the point will be written to that domain, otherwise it will be written to the domain named default. In any case, the domain can always be overridden by qualifying the point name as domain name:point name (see qualifyName).

If the point has been registered (see registerPoint), and the DataHub point is successfully written, then the onPointEcho method will be invoked.

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

status: ST_NO_POINT

msg: "Point does not exist"

Examples

CDataHubPoint point;
point.name = "point1";
point.type = PT_TYPE_REAL;
point.quality = PT_QUALITY_GOOD;
point.value = 123.456;
setPointTimeStamp(&point);
writePoint(&point, FALSE);	// point must exist or error is generated

// write real-valued point, create if needed
writePoint(_T("point2"), 123.456);

`ST_STATUS writePoint(`	CDataHubPoint&	`point`,
	bool	`create`=TRUE,
	int	`force`=FALSE`)`;

`ST_STATUS writePoint(`	LPCTSTR	`pointname`,
	int	`value`,
	bool	`create`=TRUE,
	bool	`force`=FALSE`)`;

`ST_STATUS writePoint(`	LPCTSTR	`pointname`,
	double	`value`,
	bool	`create`=TRUE,
	bool	`force`=FALSE`)`;

`ST_STATUS writePoint(`	LPCTSTR	`pointname`,
	LPCTSTR	`value`,
	bool	`create`=TRUE,
	bool	`force`=FALSE`)`;

`Exception writePoint(`	DataHubPoint	`point`,
	boolean	`create`,
	boolean	`force)`;

`Exception writePoint(`	String	`pointname`,
	String	`value`,
	boolean	`create`,
	boolean	`force)`;


writeCommand		Callback Methods

writePoint

Syntax

For C++:

For Java:

For C#:

Parameters

Returns

For C++:

Description

Examples

See Also

`writePoint`