javafish.clients.opc.browser
Class JOpcBrowser

java.lang.Object
  extended by javafish.clients.opc.JCustomOpc
      extended by javafish.clients.opc.browser.JOpcBrowser

public class JOpcBrowser
extends JCustomOpc

OPC Browser: browses brances and items of OPC Server. Uses OPCEnum to find OPC Servers on a specific host.


Constructor Summary
JOpcBrowser(java.lang.String host, java.lang.String serverProgID, java.lang.String serverClientHandle)
          Create new opc-browser
 
Method Summary
 java.lang.String[] getOpcBranch(java.lang.String branch)
          Get branch of OPC browser tree
 java.lang.String[] getOpcItems(java.lang.String leaf, boolean download)
          Get items descriptions.
static java.lang.String[] getOpcServers(java.lang.String host)
          STATIC: Get OPC-Servers from host computer
 
Methods inherited from class javafish.clients.opc.JCustomOpc
coInitialize, connect, coUninitialize, getFullOpcServerName, getHost, getServerClientHandle, getServerProgID, ping
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JOpcBrowser

public JOpcBrowser(java.lang.String host,
                   java.lang.String serverProgID,
                   java.lang.String serverClientHandle)
Create new opc-browser

Parameters:
host - String - server / personal computer tcp/ip address (name)
serverProgID - String - OPC Server full name
serverClientHandle - - user description of opc-browser
Method Detail

getOpcServers

public static java.lang.String[] getOpcServers(java.lang.String host)
                                        throws HostException,
                                               NotFoundServersException
STATIC: Get OPC-Servers from host computer

Parameters:
host - String - computer name (tcp/ip)
Returns:
servers String[] - returned array with names of OPC Servers
Throws:
HostException
NotFoundServersException

getOpcBranch

public java.lang.String[] getOpcBranch(java.lang.String branch)
                                throws UnableBrowseBranchException,
                                       UnableIBrowseException
Get branch of OPC browser tree

Parameters:
branch - String
Returns:
items of branch String[]
Throws:
UnableBrowseBranchException
UnableIBrowseException

getOpcItems

public java.lang.String[] getOpcItems(java.lang.String leaf,
                                      boolean download)
                               throws UnableBrowseLeafException,
                                      UnableIBrowseException,
                                      UnableAddGroupException,
                                      UnableAddItemException
Get items descriptions.

Structure of response: Array of items, each row is divided to the sections by ;
Structure: fullItemName; itemType; itemName; [itemValue]

Parameters:
leaf - of branch (items) String
download - - if is true, Client downloads last value of items
Returns:
description of items String[]
Throws:
UnableBrowseLeafException
UnableIBrowseException
UnableAddGroupException
UnableAddItemException