org.lsst.ccs.drivers.ads.wrapper

Interface ADSLibrary

All Superinterfaces:

com.sun.jna.Library

public interface ADSLibrary
extends com.sun.jna.Library

Defines the interface to the Beckhoff ADS library written in C++.

ADS return codes can be found in the Beckhoff Information System. A search for "ADS return codes" will find many pages each with a link to the actual page listing the codes. They keep re-organizing the info system so a simple link here would probably break.

Author:

tether

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ADSLibrary.AmsPort
static class	ADSLibrary.DeviceState Possible states for an ADS device.
static class	ADSLibrary.ErrorCode ADS error codes.
static class	ADSLibrary.IndexGroup The index group numbers meaningful to ADS.
static class	ADSLibrary.TransMode Transmission modes for ADS notifications.

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_CLASSLOADER, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_OPEN_FLAGS, OPTION_STRING_ENCODING, OPTION_STRUCTURE_ALIGNMENT, OPTION_SYMBOL_PROVIDER, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
long	AdsAddRoute(AmsNetId ams, String ip) Add a new local AMS route to a target system.
void	AdsDelRoute(AmsNetId ams) Delete a local AMS route that had previously been added with AdsAddRoute().
long	AdsGetLocalAddressEx(long port, AmsAddr pAddr) Returns the local NetId and port number.
long	AdsPortCloseEx(long port) The connection (communication port) to the message router is closed.
long	AdsPortOpenEx() Establishes a connection (communication port) to the message router.
void	AdsSetLocalAddress(AmsNetId ams) Change local NetId.
long	AdsSyncAddDeviceNotificationReqEx(long port, AmsAddr pAddr, int indexGroup, int indexOffset, AdsNotificationAttrib pAttrib, PAdsNotificationFuncEx pFunc, int hUser, int[] pNotification) A notification is defined within an ADS server (e.g.
long	AdsSyncDelDeviceNotificationReqEx(long port, AmsAddr pAddr, int hNotification) A notification defined previously is deleted from an ADS server.
long	AdsSyncGetTimeoutEx(long port, int[] timeout) Read the configured timeout for the ADS functions.
long	AdsSyncReadDeviceInfoReqEx(long port, AmsAddr pAddr, String devName, AdsVersion version) Reads the identification and version number of an ADS server.
long	AdsSyncReadReqEx2(long port, AmsAddr pAddr, int indexGroup, int indexOffset, int bufferLength, byte[] buffer, int[] bytesRead) Reads data synchronously from an ADS server.
long	AdsSyncReadStateReqEx(long port, AmsAddr pAddr, short[] adsState, short[] devState) Reads the ADS status and the device status from an ADS server.
long	AdsSyncReadWriteReqEx2(long port, AmsAddr pAddr, int indexGroup, int indexOffset, int readLength, byte[] readData, int writeLength, byte[] writeData, int[] bytesRead) Writes data synchronously into an ADS server and receives data back from the ADS server.
long	AdsSyncSetTimeoutEx(long port, int timeout) Alters the timeout for the ADS functions.
long	AdsSyncWriteControlReqEx(long port, AmsAddr pAddr, short adsState, short devState, int bufferLength, byte[] buffer) Changes the ADS status and the device status of an ADS server.
long	AdsSyncWriteReqEx(long port, AmsAddr pAddr, int indexGroup, int indexOffset, int bufferLength, byte[] buffer) Writes data synchronously to an ADS server.

Method Detail

AdsAddRoute

long AdsAddRoute(AmsNetId ams,
                 String ip)

Add a new local AMS route to a target system.

Parameters:

ams - (In) AMS address of the target system.

ip - (In) IP address of the target system.

Returns:

[ADS Return Code]

AdsDelRoute

void AdsDelRoute(AmsNetId ams)

Delete a local AMS route that had previously been added with AdsAddRoute().

Parameters:

ams - (In) address of the target system

AdsPortCloseEx

long AdsPortCloseEx(long port)

The connection (communication port) to the message router is closed. The port to be closed must previously have been opened via an AdsPortOpenEx() call.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

Returns:

[ADS Return Code]

AdsPortOpenEx

long AdsPortOpenEx()

Establishes a connection (communication port) to the message router. The port number returned by AdsPortOpenEx() is required as parameter for further AdsLib function calls.

Returns:

port number of a new Ads port or 0 if no more ports available

AdsGetLocalAddressEx

long AdsGetLocalAddressEx(long port,
                          AmsAddr pAddr)

Returns the local NetId and port number.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

pAddr - (Out) Reference to the structure of type AmsAddr.

Returns:

[ADS Return Code]

AdsSetLocalAddress

void AdsSetLocalAddress(AmsNetId ams)

Change local NetId.

Parameters:

ams - (In) local AmsNetId

AdsSyncReadReqEx2

long AdsSyncReadReqEx2(long port,
                       AmsAddr pAddr,
                       int indexGroup,
                       int indexOffset,
                       int bufferLength,
                       byte[] buffer,
                       int[] bytesRead)

Reads data synchronously from an ADS server.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

pAddr - (In) Structure with NetId and port number of the ADS server.

indexGroup - (In) Index Group.

indexOffset - (In) Index Offset.

bufferLength - (In) Length of the data in bytes.

buffer - (Out) Pointer to a data buffer that will receive the data.

bytesRead - (Out) Pointer to a variable. If successful, this variable will return the number of actually read data bytes.

Returns:

[ADS Return Code]

AdsSyncReadDeviceInfoReqEx

long AdsSyncReadDeviceInfoReqEx(long port,
                                AmsAddr pAddr,
                                String devName,
                                AdsVersion version)

Reads the identification and version number of an ADS server.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

pAddr - (In) Structure with NetId and port number of the ADS server.

devName - (Out) Pointer to a character string of at least 16 bytes, that will receive the name of the ADS device.

version - (Out) Address of a variable of type AdsVersion, which will receive the version number, revision number and the build number.

Returns:

[ADS Return Code]

AdsSyncReadStateReqEx

long AdsSyncReadStateReqEx(long port,
                           AmsAddr pAddr,
                           short[] adsState,
                           short[] devState)

Reads the ADS status and the device status from an ADS server.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

pAddr - (In) Structure with NetId and port number of the ADS server.

adsState - (Out) Address of a variable that will receive the ADS status. Search for "ADSSTATE ADS DLL" in the infosystem.

devState - (Out) Address of a variable that will receive the device status.

Returns:

[ADS Return Code]

AdsSyncReadWriteReqEx2

long AdsSyncReadWriteReqEx2(long port,
                            AmsAddr pAddr,
                            int indexGroup,
                            int indexOffset,
                            int readLength,
                            byte[] readData,
                            int writeLength,
                            byte[] writeData,
                            int[] bytesRead)

Writes data synchronously into an ADS server and receives data back from the ADS server.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

pAddr - (In) Structure with NetId and port number of the ADS server.

indexGroup - (In) Index Group.

indexOffset - (In) Index Offset.

readLength - (In) Length, in bytes, of the read buffer readData.

readData - (Out) Buffer for data read from the ADS server.

writeLength - (In) Length of the data, in bytes, send to the ADS server.

writeData - (In) Buffer with data send to the ADS server.

bytesRead - (Out) pointer to a variable. If successful, this variable will return the number of actually read data bytes.

Returns:

[ADS Return Code]

AdsSyncWriteReqEx

long AdsSyncWriteReqEx(long port,
                       AmsAddr pAddr,
                       int indexGroup,
                       int indexOffset,
                       int bufferLength,
                       byte[] buffer)

Writes data synchronously to an ADS server.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

pAddr - (In) Structure with NetId and port number of the ADS server.

indexGroup - (In) Index Group.

indexOffset - (In) Index Offset.

bufferLength - (In) Length, in bytes, of the read buffer readData.

buffer - (Out) Buffer for data read from the ADS server.

Returns:

[ADS Return Code]

AdsSyncWriteControlReqEx

long AdsSyncWriteControlReqEx(long port,
                              AmsAddr pAddr,
                              short adsState,
                              short devState,
                              int bufferLength,
                              byte[] buffer)

Changes the ADS status and the device status of an ADS server.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

pAddr - (In) Structure with NetId and port number of the ADS server.

adsState - (In) New ADS status.

devState - (In) New device status.

bufferLength - (In) Length of the additional data, in bytes, send to the ADS server.

buffer - (In) Buffer with additional data send to the ADS server.

Returns:

[ADS Return Code]

AdsSyncAddDeviceNotificationReqEx

long AdsSyncAddDeviceNotificationReqEx(long port,
                                       AmsAddr pAddr,
                                       int indexGroup,
                                       int indexOffset,
                                       AdsNotificationAttrib pAttrib,
                                       PAdsNotificationFuncEx pFunc,
                                       int hUser,
                                       int[] pNotification)

A notification is defined within an ADS server (e.g. PLC). When a certain event occurs a function (the callback function) is invoked in the ADS client (C program).

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

pAddr - (In) Structure with NetId and port number of the ADS server.

indexGroup - (In) Index Group.

indexOffset - (In) Index Offset.

pAttrib - (In) Pointer to the structure that contains further information.

pFunc - (In) Pointer to the structure describing the callback function.

hUser - (In) 32-bit value that is passed to the callback function.

pNotification - (Out) Address of the variable that will receive the handle of the notification.

Returns:

[ADS Return Code]

AdsSyncDelDeviceNotificationReqEx

long AdsSyncDelDeviceNotificationReqEx(long port,
                                       AmsAddr pAddr,
                                       int hNotification)

A notification defined previously is deleted from an ADS server.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

pAddr - (In) Structure with NetId and port number of the ADS server.

hNotification - (In) The handle of the notification.

Returns:

[ADS Return Code]

AdsSyncGetTimeoutEx

long AdsSyncGetTimeoutEx(long port,
                         int[] timeout)

Read the configured timeout for the ADS functions. The standard value is 5000 ms.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

timeout - (Out) Buffer to store timeout value in ms.

Returns:

[ADS Return Code]

AdsSyncSetTimeoutEx

long AdsSyncSetTimeoutEx(long port,
                         int timeout)

Alters the timeout for the ADS functions. The standard value is 5000 ms.

Parameters:

port - (In) port number of an Ads port that had previously been opened with AdsPortOpenEx().

timeout - (In) Timeout in ms.

Returns:

[ADS Return Code]