org.openscada.opc.dcom.da.impl

Class OPCGroupStateMgt

java.lang.Object

org.openscada.opc.dcom.common.impl.BaseCOMObject

org.openscada.opc.dcom.da.impl.OPCGroupStateMgt

public class OPCGroupStateMgt
extends BaseCOMObject

Implementation of IOPCGroupStateMgt

Author:

Jens Reimann

Constructor Summary

Constructors

Constructor and Description
OPCGroupStateMgt(IJIComObject opcGroup)

Method Summary

Modifier and Type	Method and Description
EventHandler	attach(IOPCDataCallback callback) Attach a new callback to the group
OPCGroupStateMgt	clone(String name) Clone the group
OPCAsyncIO2	getAsyncIO2()
OPCItemMgt	getItemManagement()
OPCGroupState	getState()
OPCSyncIO	getSyncIO()
void	setName(String name) Rename to group
int	setState(Integer requestedUpdateRate, Boolean active, Integer timeBias, Float percentDeadband, Integer localeID, Integer clientHandle) Set the group state Leaving any of the parameters null will keep the current value untouched.

Methods inherited from class org.openscada.opc.dcom.common.impl.BaseCOMObject

getCOMObject

Methods inherited from class java.lang.Object

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

Constructor Detail

OPCGroupStateMgt

public OPCGroupStateMgt(IJIComObject opcGroup)
                 throws IllegalArgumentException,
                        UnknownHostException,
                        JIException

Throws:

IllegalArgumentException

UnknownHostException

JIException

Method Detail

getState

public OPCGroupState getState()
                       throws JIException

Throws:

JIException

setState

public int setState(Integer requestedUpdateRate,
                    Boolean active,
                    Integer timeBias,
                    Float percentDeadband,
                    Integer localeID,
                    Integer clientHandle)
             throws JIException

Set the group state Leaving any of the parameters null will keep the current value untouched.

Parameters:

requestedUpdateRate - the requested update rate

active - Flag if the group is active or not

timeBias - The time bias

percentDeadband - the deadband percent

localeID - the locale ID

clientHandle - the client handle

Returns:

the granted update rate

Throws:

JIException

getItemManagement

public OPCItemMgt getItemManagement()
                             throws JIException

Throws:

JIException

setName

public void setName(String name)
             throws JIException

Rename to group

Parameters:

name - the new name

Throws:

JIException

clone

public OPCGroupStateMgt clone(String name)
                       throws JIException,
                              IllegalArgumentException,
                              UnknownHostException

Clone the group

Parameters:

name - the name of the cloned group

Returns:

The cloned group

Throws:

JIException

UnknownHostException

IllegalArgumentException

attach

public EventHandler attach(IOPCDataCallback callback)
                    throws JIException

Attach a new callback to the group

Parameters:

callback - The callback to attach

Returns:

The event handler information

Throws:

JIException

getAsyncIO2

public OPCAsyncIO2 getAsyncIO2()

getSyncIO

public OPCSyncIO getSyncIO()