<< Clique para Mostrar o Sumário >>   Métodos

Este tópico contém os métodos disponíveis na Biblioteca E3DataAccess.

 

BatchRegisterCallback(PathCollection)

Este método é usado para monitorar as modificações ocorridas em alguma propriedade de uma coleção de objetos instanciados no servidor E3 ou Elipse Power. A partir do momento em que as Associações são registradas, a aplicação passa a receber notificações das variações dos valores monitorados. O parâmetro PathCollection deve fornecer os caminhos para as propriedades dos objetos a ser monitoradas, separados por vírgulas, como por exemplo "Dados1.TagDemo1.Value,Dados1.TagDemo2.Value". Este método retorna Verdadeiro se as Associações foram registradas corretamente ou Falso se não foi possível registrar as Associações.

 

BatchUnregisterCallback(PathCollection)

Este método é usado para remover as Associações passadas como parâmetro da lista de monitoramento, permitindo que uma aplicação não receba mais eventos de modificação para aquelas Associações. O parâmetro PathCollection deve fornecer os caminhos para as propriedades dos objetos que devem ser removidas da lista de monitoramento, separadas por vírgula, como por exemplo "Dados1.TagDemo1.Value,Dados1.TagDemo2.Value". Este método retorna Verdadeiro se as Associações foram removidas da lista de monitoramento corretamente ou Falso se não foi possível remover as Associações da lista de monitoramento.

 

ClearCallbacks()

Este método remove todas as Associações registradas. Retorna Verdadeiro se a operação foi bem-sucedida ou False se não foi possível remover todas as Associações.

 

Connect()

Este método conecta ao servidor ou servidores relacionados na propriedade Server.

 

Disconnect()

Este método executa uma desconexão do servidor atualmente conectado.

 

ExecuteQuery(Path, Names, Values, QueryResult)

Este método executa uma Consulta e retorna os resultados, se houver. O parâmetro Path indica o caminho para um objeto Consulta a ser executado no servidor E3 ou Elipse Power, como por exemplo "Dados.Consulta1". O parâmetro Names é um array com os nomes das variáveis a serem configuradas na Consulta referenciada no parâmetro Path. O parâmetro Values é um array com os valores das variáveis referenciadas pelo parâmetro Names. O parâmetro QueryResult é uma variável que recebe uma matriz com os valores retornados pela Consulta referenciada no parâmetro Path. Este método retorna Verdadeiro se a Consulta foi executada corretamente e Falso se não foi possível encontrar ou executar a Consulta especificada no parâmetro Path.

 

GetValue(Path, Timestamp, Quality, Val)

Este método retorna o valor de uma propriedade de um objeto em um servidor E3 ou Elipse Power. O parâmetro Path fornece o caminho para um objeto a ser monitorado. O parâmetro Timestamp é uma variável que recebe a estampa de tempo da Associação referenciada pelo parâmetro Path. O parâmetro Quality é uma variável que recebe a qualidade do valor da Associação referenciada pelo parâmetro Path. O parâmetro Val é uma variável que recebe o valor da Associação referenciada pelo parâmetro Path. Este método retorna Verdadeiro se a Associação foi encontrada e os valores retornados corretamente ou Falso se não foi possível encontrar a Associação e buscar os valores.

 

Login(Login, Password)

Este método executa um login no servidor E3 ou Elipse Power usando o usuário e a senha indicados nos parâmetros Login e Password, respectivamente. Este método retorna Verdadeiro se o login foi bem-sucedido ou Falso em caso de erro.

 

Logout()

Este método executa um logout do servidor E3 ou Elipse Power do usuário indicado no método Login.

 

ReadValue(Path, Timestamp, Quality, Val)

Este método lê o valor de uma propriedade de um objeto em um servidor E3 ou Elipse Power. O parâmetro Path fornece o caminho para um objeto a ser lido. O parâmetro Timestamp é uma variável que recebe a estampa de tempo da Associação referenciada pelo parâmetro Path. O parâmetro Quality é uma variável que recebe a qualidade do valor da Associação referenciada pelo parâmetro Path. O parâmetro Val é uma variável que recebe o valor da Associação referenciada pelo parâmetro Path. Este método retorna Verdadeiro se a leitura foi bem-sucedida ou Falso se não foi possível encontrar a Associação ou retornar o valor.

 

RegisterCallback(Path)

Este método é usado para monitorar as modificações ocorridas em alguma propriedade de um objeto instanciado no servidor E3 ou Elipse Power. A partir do momento em que a Associação é registrada, a aplicação passa a receber notificações das variações do valor monitorado. O parâmetro Path fornece o caminho para a propriedade do objeto a ser monitorada, como por exemplo "Dados1.TagDemo1.Value". Este método retorna Verdadeiro se a Associação foi registrada corretamente ou Falso se não foi possível registrar a Associação.

 

ResetCommSettings()

Este método configura todas as propriedades de conexão do objeto E3DataAccess para seus valores padrão.

 

SetValue(Path, Timestamp, Quality, Val)

Este método configura o valor de uma propriedade de um objeto em um servidor E3 ou Elipse Power. O parâmetro Path fornece o caminho para um objeto a ser modificado. O parâmetro Timestamp fornece a estampa de tempo da Associação referenciada pelo parâmetro Path. O parâmetro Quality fornece a qualidade do valor da Associação referenciada pelo parâmetro Path. O parâmetro Val fornece o valor da Associação referenciada pelo parâmetro Path. Este método retorna Verdadeiro se a Associação foi encontrada e os valores configurados corretamente ou Falso se não foi possível encontrar a Associação e configurar os valores corretamente.

 

UnregisterCallback(Path)

Este método é usado para retirar a Associação passada como parâmetro da lista de monitoramento, permitindo que uma aplicação não receba mais eventos de modificação para aquela Associação. O parâmetro Path fornece o caminho para a propriedade que deve ser removida da lista de monitoramento, como por exemplo "Dados1.TagDemo1.Value". Este método retorna Verdadeiro se a Associação foi removida da lista de monitoramento corretamente ou Falso se não foi possível remover a Associação da lista de monitoramento.

 

WriteValue(Path, Timestamp, Quality, Val)

Este método escreve um valor em uma propriedade de um objeto em um servidor E3 ou Elipse Power. O parâmetro Path fornece o caminho para um objeto a ser escrito. O parâmetro Timestamp é a estampa de tempo para a Associação referenciada pelo parâmetro Path. O parâmetro Quality é a qualidade do valor para a Associação referenciada pelo parâmetro Path. O parâmetro Val é o valor para a Associação referenciada pelo parâmetro Path. Este método retorna Verdadeiro se a escrita foi bem-sucedida ou Falso se não foi possível encontrar a Associação ou escrever o valor.