org.openscada.opc.lib.da

Class Group

java.lang.Object

org.openscada.opc.lib.da.Group

public class Group
extends Object

Method Summary

Modifier and Type	Method and Description
Item	addItem(String item) Add a single item.
Map<String,Item>	addItems(String... items) Add new items to the group
EventHandler	attach(IOPCDataCallback dataCallback)
protected void	checkItems(Item[] items)
void	clear()
Item	findItemByClientHandle(int clientHandle)
OPCAsyncIO2	getAsyncIO20()
protected Item	getItemByOPCItemId(String opcItemId)
String	getName() Get the group name from the server
Server	getServer()
int	getServerHandle()
protected Integer[]	getServerHandles(Item[] items)
boolean	isActive()
Map<Item,ItemState>	read(boolean device, Item... items)
void	remove() remove the group from the server
void	removeItem(String opcItemId)
void	setActive(boolean state)
void	setActive(boolean state, Item... items)
void	setName(String name) Change the group name
Map<String,Result<OPCITEMRESULT>>	validateItems(String... items) Validate item ids and get additional information to them.
Map<Item,Integer>	write(WriteRequest... requests)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setActive

public void setActive(boolean state)
               throws JIException

Throws:

JIException

remove

public void remove()
            throws JIException

remove the group from the server

Throws:

JIException

isActive

public boolean isActive()
                 throws JIException

Throws:

JIException

getName

public String getName()
               throws JIException

Get the group name from the server

Returns:

The group name fetched from the server

Throws:

JIException

setName

public void setName(String name)
             throws JIException

Change the group name

Parameters:

name - the new name of the group

Throws:

JIException

addItem

public Item addItem(String item)
             throws JIException,
                    AddFailedException

Add a single item. Actually calls addItems(String[]) with only one paraemter

Parameters:

item - The item to add

Returns:

The added item

Throws:

JIException - The add operation failed

AddFailedException - The item was not added due to an error

validateItems

public Map<String,Result<OPCITEMRESULT>> validateItems(String... items)
                                                throws JIException

Validate item ids and get additional information to them.
According to the OPC specification you should first validate the items and the add them. The spec also says that when a server lets the item pass validation it must also let them pass the add operation.

Parameters:

items - The items to validate

Returns:

A result map of item id to result information (including error code).

Throws:

JIException

addItems

public Map<String,Item> addItems(String... items)
                          throws JIException,
                                 AddFailedException

Add new items to the group

Parameters:

items - The items (by string id) to add

Returns:

A result map of id to item object

Throws:

JIException - The add operation completely failed. No item was added.

AddFailedException - If one or more item could not be added. Item without error where added.

getItemByOPCItemId

protected Item getItemByOPCItemId(String opcItemId)

checkItems

protected void checkItems(Item[] items)

setActive

public void setActive(boolean state,
                      Item... items)
               throws JIException

Throws:

JIException

getServerHandles

protected Integer[] getServerHandles(Item[] items)

write

public Map<Item,Integer> write(WriteRequest... requests)
                        throws JIException

Throws:

JIException

read

public Map<Item,ItemState> read(boolean device,
                                Item... items)
                         throws JIException

Throws:

JIException

getServer

public Server getServer()

clear

public void clear()
           throws JIException

Throws:

JIException

getAsyncIO20

public OPCAsyncIO2 getAsyncIO20()

attach

public EventHandler attach(IOPCDataCallback dataCallback)
                    throws JIException

Throws:

JIException

findItemByClientHandle

public Item findItemByClientHandle(int clientHandle)

getServerHandle

public int getServerHandle()

removeItem

public void removeItem(String opcItemId)
                throws IllegalArgumentException,
                       UnknownHostException,
                       JIException

Throws:

IllegalArgumentException

UnknownHostException

JIException