<< Click to Display Table of Contents >>   Methods

This topic contains the available methods in the E3DataAccess Library.

 

BatchRegisterCallback(PathCollection)

This method is used to monitor changes occurred in any property of a collection of objects instantiated in an E3 or Elipse Power server. From the moment these Links are registered, the application starts receiving notifications of changes in the monitored values. The PathCollection parameter must provide the paths to object properties to monitor, separated by commas, such as "Data1.DemoTag1.Value,Data1.DemoTag2.Value". This method returns True if the Links were registered correctly or False if the Links could not be registered.

 

BatchUnregisterCallback(PathCollection)

This method is used to remove Links passed as the parameter of a list of monitoring, allowing an application to stop receiving change events for those Links. The PathCollection parameter must provide the paths to object properties to remove from the list of monitoring, separated by commas, such as "Data1.DemoTag1.Value,Data1.DemoTag2.Value". This method returns True if the Links were correctly removed from the list of monitoring or False if the Links could not be removed from the list of monitoring.

 

ClearCallbacks()

This method removes all registered Links. Returns True if this operation was successful or False if it could not remove all Links.

 

Connect()

This method connects to the server or servers listed in the Server property.

 

Disconnect()

This method performs a disconnection from the currently connected server.

 

ExecuteQuery(Path, Names, Values, QueryResult)

This method executes a Query and returns its results, if any. The Path parameter indicates the path to a Query object to execute in the E3 or Elipse Power server, such as "Data.Query1". The Names parameter is an array with names of variables to configure in the Query referenced in the Path parameter. The Values parameter is an array with values of variables referenced by the Names parameter. The QueryResult parameter is a variable that receives a matrix with the values returned by the Query referenced in the Path parameter. This method returns True if the Query was correctly executed and False if the Query specified in the Path parameter could not be found or executed.

 

GetValue(Path, Timestamp, Quality, Val)

This method returns the value of an object's property in an E3 or Elipse Power server. The Path parameter provides the path to an object to monitor. The Timestamp parameter is a variable that receives a Link's timestamp referenced by the Path parameter. The Quality parameter is a variable that receives the quality of a Link's value referenced by the Path parameter. The Val parameter is a variable that receives the value of a Link referenced by the Path parameter. This method returns True if the Link was found and the values returned correctly or False if the Link was not found and the values could not be retrieved.

 

Login(Login, Password)

This method executes a login on the E3 or Elipse Power server using the user name and password indicated in the Login and Password parameters, respectively. This method returns True if the login was successful or False in case of error.

 

Logout()

This method performs a logout from the E3 or Elipse Power server of the user indicated in the Login method.

 

ReadValue(Path, Timestamp, Quality, Val)

This method reads the value of an object's property in an E3 or Elipse Power server. The Path parameter provides the path to an object to read. The Timestamp parameter is a variable that receives the timestamp of the Link referenced by the Path parameter. The Quality parameter is a variable that receives the quality of the Link's value referenced by the Path parameter. The Val parameter is a variable that receives the Link's value referenced by the Path parameter. This method returns True if that reading was successful or False if the Link was not found or could not return its value.

 

RegisterCallback(Path)

This method is used to monitor changes occurred in any property of an object instantiated in the E3 or Elipse Power server. From the moment this Link is registered, the application starts receiving notifications of variations in the monitored value. The Path parameter provides the path to an object's property to monitor, such as "Data1.DemoTag1.Value". This method returns True if the Link was correctly registered or False if the Link could not be registered.

 

ResetCommSettings()

This methods configures all connection properties of an E3DataAccess object to their default values.

 

SetValue(Path, Timestamp, Quality, Val)

This method configures the value of an object's property in an E3 or Elipse Power server. The Path parameter provides the path to an object to change. The Timestamp parameter provides the Link's timestamp referenced by the Path parameter. The Quality parameter provides the quality of Link's value referenced by the Path parameter. The Val parameter provides the Link's value referenced by the Path parameter. This method returns True if the Link was found and its values configured correctly or False if the Link was not found and its values could not be configured correctly.

 

UnregisterCallback(Path)

This method is used to remove the Link passed as a parameter from the list of monitoring, allowing an application to stop receiving change events for that Link. The Path parameter provides the path to the property to remove from the list of monitoring, such as "Data1.DemoTag1.Value". This method returns True if the Link was removed correctly from the list of monitoring or False if the Link could not be removed from the list of monitoring.

 

WriteValue(Path, Timestamp, Quality, Val)

This method writes a value to an object's property in an E3 or Elipse Power server. The Path parameter provides the path to an object to write. The Timestamp parameter is a timestamp for the Link referenced by the Path parameter. The Quality parameter is the quality of the value for the Link referenced by the Path parameter. The Val parameter is the value for the Link referenced by the Path parameter. This method returns True if that writing was successful or False if the Link could not be found or the value cannot be written.