|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavafish.clients.opc.component.OpcGroup
public class OpcGroup
OPC Group class
| Constructor Summary | |
|---|---|
OpcGroup(java.lang.String groupName,
boolean active,
int updateRate,
float percentDeadBand)
Create new instance of OPC Group |
|
| Method Summary | |
|---|---|
void |
addAsynchListener(OpcAsynchGroupListener listener)
Add asynch-group listener |
void |
addItem(OpcItem item)
Add item to group note: throws ItemExistsException - runtime exception |
java.lang.Object |
clone()
Return clone of opc-group |
void |
generateClientHandleByOwner(JOpc opc)
Generate clientHandle by its owner. |
javax.swing.event.EventListenerList |
getAsynchListeners()
Get asynchronous group listeners list |
int |
getClientHandle()
Get clientHandle of group (unique key) |
java.lang.String |
getGroupName()
Get group name |
OpcItem |
getItemByClientHandle(int clientHandle)
Get opc-item by its clientHandle |
java.util.ArrayList<OpcItem> |
getItems()
Get items as array list |
OpcItem[] |
getItemsAsArray()
Get items as array |
int |
getNewItemClientHandle()
Generate new clientHandle for its item. |
float |
getPercentDeadBand()
Get percent dead band of group |
int |
getUpdateRate()
Get update rate of group |
boolean |
isActive()
Test activity of group |
void |
removeAsynchListener(OpcAsynchGroupListener listener)
Remove asynch-group listener |
void |
removeItem(OpcItem item)
Remove item from group note: throws ItemExistsException - runtime exception |
void |
setActive(boolean active)
Set activity of group |
void |
setUpdateRate(int updateRate)
Set update rate of group |
java.lang.String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public OpcGroup(java.lang.String groupName,
boolean active,
int updateRate,
float percentDeadBand)
groupName - String (user identificatio name of group)active - boolean - begin activity of groupupdateRate - double - refresh time of group in millisecondspercentDeadBand - float - see percentDeadBand definition:
Deadband will only apply to items in the group that
have a dwEUType of Analog available. If the dwEUType is Analog,
then the EU Low and EU High values for the item can be used to
calculate the range for the item. This range will be multiplied with
the Deadband to generate an exception limit.
An exception is determined as follows:
Exception if (absolute value of (last cached value - current value) > pPercentDeadband * (EU High - EU Low) )
If the exception limit is exceeded, then the last cached value is updated with the new value and a notification will be sent to the IAdviseSink (if any). The pPercentDeadband is an optional behavior for the server. If the client does not specify this value on a server that does support the behavior, the default value of 0 (zero) will be assumed, and all value changes will update the CACHE. Note that the timestamp will be updated regardless of wether the cached value is updated.
| Method Detail |
|---|
public void generateClientHandleByOwner(JOpc opc)
opc - JOpcpublic int getNewItemClientHandle()
It is internal support for generation of unique items ID.
public boolean isActive()
public void setActive(boolean active)
active - booleanpublic java.util.ArrayList<OpcItem> getItems()
public OpcItem[] getItemsAsArray()
public void addItem(OpcItem item)
note: throws ItemExistsException - runtime exception
item - OpcItempublic void removeItem(OpcItem item)
note: throws ItemExistsException - runtime exception
item - OpcItempublic int getUpdateRate()
public void setUpdateRate(int updateRate)
updateRate - [ms], intpublic int getClientHandle()
public java.lang.String getGroupName()
public float getPercentDeadBand()
public OpcItem getItemByClientHandle(int clientHandle)
clientHandle - int
public void addAsynchListener(OpcAsynchGroupListener listener)
listener - OpcReportListenerpublic void removeAsynchListener(OpcAsynchGroupListener listener)
listener - OpcReportListenerpublic javax.swing.event.EventListenerList getAsynchListeners()
public java.lang.Object clone()
clone in class java.lang.Objectpublic java.lang.String toString()
toString in class java.lang.Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||