org.lsst.ccs.drivers.ads.wrapper

Class AdsNotificationAttrib

java.lang.Object

com.sun.jna.Structure

org.lsst.ccs.drivers.ads.wrapper.AdsNotificationAttrib

public class AdsNotificationAttrib
extends com.sun.jna.Structure

This structure contains all the attributes for the definition of a notification request. A TwinCAT ADS server maintains a FIFO into which notifications are written. The notifications are actually sent if the FIFO fills up or it's been too long since the last time the FIFO was emptied, whichever come first.

Warning: Too many notifications can load the system so heavily that the user interface becomes much slower.

Tip: Set the cycle time to the most appropriate values, and always close connections when they are no longer required.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.ByReference, com.sun.jna.Structure.ByValue, com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
int	cbLength
int	nCycleTime
int	nMaxDelay
int	nTransMode

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
AdsNotificationAttrib() For use by JNA.
AdsNotificationAttrib(int cbLength, int nTransMode, int nMaxDelay, int nCycleTime)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
protected List<String>	getFieldOrder()
int	hashCode()

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

cbLength

public int cbLength

nTransMode

public int nTransMode

nMaxDelay

public int nMaxDelay

nCycleTime

public int nCycleTime

Constructor Detail

AdsNotificationAttrib

public AdsNotificationAttrib(int cbLength,
                             int nTransMode,
                             int nMaxDelay,
                             int nCycleTime)

Parameters:

cbLength - Length in bytes of the data that is to be transmitted from the server and passed to the client's callback function.

nTransMode - See ADSLibrary.TransMode

nMaxDelay - The maximum length of time that a notification may spend in the server's FIFO before being sent to the client. Normally the server will wait until the FIFO is full. The time unit is 100 nanosec.

nCycleTime - Specifies the interval in 100 ns units between the times when the ADS server decides whether or not to send a new notification. The smallest possible value is the cycle time of the ADS server; for the PLC, this is the task cycle time. This is also what you get when you use a value of zero.

AdsNotificationAttrib

public AdsNotificationAttrib()

For use by JNA.

Method Detail

getFieldOrder

protected List<String> getFieldOrder()

Overrides:

getFieldOrder in class com.sun.jna.Structure

hashCode

public int hashCode()

Overrides:

hashCode in class com.sun.jna.Structure

equals

public boolean equals(Object obj)

Overrides:

equals in class com.sun.jna.Structure