DESY ACOP Beans Home

de.desy.acop.transport
Class AcopTransport

java.lang.Object
  extended by de.desy.acop.transport.AcopTransport
All Implemented Interfaces:
ConnectionParametersReceiver

public class AcopTransport
extends java.lang.Object
implements ConnectionParametersReceiver


Nested Class Summary
 class AcopTransport.AcopCallback
           
 
Field Summary
protected  java.lang.String acopConfig
           
protected  java.util.Vector acopLinkTable
           
protected  AcopTransportCallback atc
           
protected  AcopTransportFactory atf
           
protected  java.util.Date dateStamp
           
protected  int GroupIndex
           
 boolean isGrouped
           
protected  int lastUpdatedDataSize
           
protected  int lastUpdatedDataSizeEx
           
protected  int lastUpdatedLink
           
protected  javax.swing.event.EventListenerList listeners
           
protected  int ReceiveQueueDepth
           
protected  java.lang.String Status
           
protected  double TimeStamp
           
 
Fields inherited from interface de.desy.acop.displayers.tools.ConnectionParametersReceiver
CONNECTION_PARAMETERS_PROPERTY
 
Constructor Summary
AcopTransport()
           
 
Method Summary
 int acquireDisplayProperties()
           
 int acquireDisplayProperties(Acop a, java.lang.String deviceContext, java.lang.String deviceGroup, java.lang.String deviceName, java.lang.String deviceProperty)
           
 int acquireDisplayProperties(java.lang.String deviceContext, java.lang.String deviceGroup, java.lang.String deviceName, java.lang.String deviceProperty)
           
 void addAcopTransportListener(AcopTransportListener l)
           
 int addAcopTransportProtocol(AcopTransportPlug plug)
           
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a PropertyChangeListener which listenes to all properties.
 void addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
          Adds a PropertyChangeListener to this receiver.
 int attachLink(java.lang.Object Data)
           
 int attachLink(java.lang.Object Data, int ArraySize)
           
 int attachLink(java.lang.Object Data, int ArraySize, int identifier)
           
 int attachLink(java.lang.Object Data, int ArraySize, java.lang.Object DataEx, int ArraySizeEx)
           
 int attachLink(java.lang.Object Data, int ArraySize, java.lang.Object DataEx, int ArraySizeEx, int identifier)
           
 int attachLink(java.lang.Object Data, java.lang.Object DataEx)
           
 int closeLink(int hLink)
           
 int execute(java.lang.Object Data)
           
 int execute(java.lang.Object Data, int ArraySize)
           
 int execute(java.lang.Object Data, int ArraySize, java.lang.Object DataEx, int ArraySizeEx)
           
 int execute(java.lang.Object Data, java.lang.Object DataEx)
           
protected  void firePropertyChange(java.lang.String propertyName, java.lang.Object oldValue, java.lang.Object newValue)
           
 AccessMode getAccessMode()
           
 java.lang.String getAccessProtocol()
           
 java.lang.String getAccessRate()
           
 java.lang.String getAcopConfig()
           
 java.util.Vector getAcopLinkTable()
           
 int getAcopLinkTableId(AcopTransportRequest atr)
           
 int getAcopLinkTableId(int hLink)
           
 int getAcopLinkTableIdFromCallbackId(int hLinkCallback)
           
protected  AcopTransportRequest getAcopTransportRequest(AcopTransportRequest atr)
           
protected  AcopTransportRequest getAcopTransportRequest(int hLink)
           
 java.lang.String getConnectionInformation(int hLink)
           
 java.lang.String getConnectionInformation(java.lang.String deviceContext, java.lang.String deviceGroup, java.lang.String deviceName, java.lang.String deviceProperty)
           
 ConnectionParameters getConnectionParameters()
          Returns the connectionParameters.
 int getData(java.lang.Object Data, java.lang.Object DataEx, int hLink)
           
 int getDataSize()
           
 int getDataSize(int identifier)
           
 int getDataSize(int[] DataSize, int[] DataSizeEx, int hLink)
           
 int getDataSizeEx()
           
 int getDataSizeEx(int identifier)
           
 double getDataTimeStamp()
           
 double getDataTimeStamp(int hLink)
           
 java.util.Date getDateStamp()
           
 java.util.Date getDateStamp(int hLink)
           
 java.lang.String getDeviceContext()
           
 java.lang.String[] getDeviceContexts()
           
 java.lang.String getDeviceGroup()
           
 java.lang.String[] getDeviceGroups()
           
 java.lang.String[] getDeviceGroups(java.lang.String deviceContext, java.lang.String deviceGroup, java.lang.String deviceName, java.lang.String deviceProperty)
           
 java.lang.String getDeviceName()
           
 java.lang.String[] getDeviceNames()
           
 java.lang.String[] getDeviceNames(java.lang.String deviceContext, java.lang.String deviceGroup, java.lang.String deviceName, java.lang.String deviceProperty)
           
 java.lang.String[] getDeviceProperties()
           
 java.lang.String[] getDeviceProperties(java.lang.String deviceContext, java.lang.String deviceGroup, java.lang.String deviceName, java.lang.String deviceProperty)
           
 java.lang.String getDeviceProperty()
           
protected  int getFreeIdentifier()
           
 boolean getGrouped()
           
 int getGroupIndex()
           
 int getObjectSize(java.lang.Object data)
           
 java.lang.String getPropertySize()
           
 int getReceiveQueueDepth()
           
 java.lang.String getStatus()
           
 java.lang.String getStatus(int hLink)
           
 int getStatusCode(int hLink)
           
 java.util.Date getTimeStamp()
           
 double[] getXAxis(java.lang.Object data)
           
 java.lang.String[] getXAxisChannelNames(java.lang.Object data)
           
 double[] getYAxis(java.lang.Object data)
           
 void halt()
           
 int openLink(java.lang.Object Data)
           
 int openLink(java.lang.Object Data, int ArraySize)
           
 int openLink(java.lang.Object Data, int ArraySize, int identifier)
           
 int openLink(java.lang.Object Data, int ArraySize, java.lang.Object DataEx, int ArraySizeEx)
           
 int openLink(java.lang.Object Data, int ArraySize, java.lang.Object DataEx, int ArraySizeEx, int identifier)
           
 int openLink(java.lang.Object Data, java.lang.Object DataEx)
           
 void removeAcopTransportListener(AcopTransportListener l)
           
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a PropertyChangeListener.
 void removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)
          Removes a PropertyChangeListener associated with the specified property.
 void setAccessMode(AccessMode am)
           
 void setAccessProtocol(java.lang.String accessProtocol)
           
 void setAccessRate(java.lang.String accessRate)
           
 void setAcopConfig(java.lang.String AcopConfig)
           
 void setConnectionParameters(ConnectionParameters connectionParameters)
          Sets new connectionParameters.
 void setDeviceContext(java.lang.String deviceContext)
           
 void setDeviceGroup(java.lang.String deviceGroup)
           
 void setDeviceName(java.lang.String deviceName)
           
 void setDeviceProperty(java.lang.String deviceProperty)
           
 void setGrouped(boolean Grouped)
           
 int setLinkIdentifier(int currentLinkIdentifier, int linkIdentifier)
           
 void setPropertySize(java.lang.String propertySize)
           
 void setReceiveQueueDepth(int ReceiveQueueDepth)
           
 void setTimeStamp(java.util.Date TimeStamp)
           
 void setTimeStamp(double TimeStamp)
           
 void setTimeStamp(int TimeStamp)
           
 java.lang.String toTimeString(java.util.Date TimeStamp)
           
 java.lang.String toTimeString(double TimeStamp)
           
 java.lang.String toTimeString(int TimeStamp)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

acopConfig

protected java.lang.String acopConfig

Status

protected java.lang.String Status

isGrouped

public boolean isGrouped

GroupIndex

protected int GroupIndex

ReceiveQueueDepth

protected int ReceiveQueueDepth

TimeStamp

protected double TimeStamp

dateStamp

protected java.util.Date dateStamp

atf

protected AcopTransportFactory atf

acopLinkTable

protected final java.util.Vector acopLinkTable

lastUpdatedLink

protected int lastUpdatedLink

lastUpdatedDataSize

protected int lastUpdatedDataSize

lastUpdatedDataSizeEx

protected int lastUpdatedDataSizeEx

listeners

protected javax.swing.event.EventListenerList listeners

atc

protected AcopTransportCallback atc
Constructor Detail

AcopTransport

public AcopTransport()
Method Detail

getConnectionInformation

public java.lang.String getConnectionInformation(java.lang.String deviceContext,
                                                 java.lang.String deviceGroup,
                                                 java.lang.String deviceName,
                                                 java.lang.String deviceProperty)

getConnectionInformation

public java.lang.String getConnectionInformation(int hLink)

getReceiveQueueDepth

public int getReceiveQueueDepth()

getDataTimeStamp

public double getDataTimeStamp()

getDataTimeStamp

public double getDataTimeStamp(int hLink)

getDateStamp

public java.util.Date getDateStamp()

getDateStamp

public java.util.Date getDateStamp(int hLink)

getAcopLinkTable

public java.util.Vector getAcopLinkTable()

addAcopTransportProtocol

public int addAcopTransportProtocol(AcopTransportPlug plug)

getAcopTransportRequest

protected AcopTransportRequest getAcopTransportRequest(AcopTransportRequest atr)

getAcopTransportRequest

protected AcopTransportRequest getAcopTransportRequest(int hLink)

getAcopLinkTableId

public int getAcopLinkTableId(AcopTransportRequest atr)

getAcopLinkTableId

public int getAcopLinkTableId(int hLink)

getAcopLinkTableIdFromCallbackId

public int getAcopLinkTableIdFromCallbackId(int hLinkCallback)

getFreeIdentifier

protected int getFreeIdentifier()

halt

public void halt()

execute

public int execute(java.lang.Object Data,
                   int ArraySize,
                   java.lang.Object DataEx,
                   int ArraySizeEx)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
ArraySize - is the data array size associated with the Data object. This may be smaller than the actual size of the Data object, but NOT bigger.
DataEx - is the extended data object and refers to the data object to which holds the input data to be sent to a server. Pass 'null' if no return data is desired.
ArraySizeEx - is the data array size associated with the DataEx object. This may be smaller than the actual size of the DataEx object, but NOT bigger.
Returns:
0 if successful otherwise a positive return code or -1, in which case the getStatus() method can be queried to determine the cause of failure.

execute

public int execute(java.lang.Object Data,
                   java.lang.Object DataEx)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
DataEx - is the extended data object and refers to the data object to which holds the input data to be sent to a server. Pass 'null' if no return data is desired.
Returns:
0 if successful otherwise a positive return code or -1, in which case the getStatus() method can be queried to determine the cause of failure.

execute

public int execute(java.lang.Object Data)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
Returns:
0 if successful otherwise a positive return code or -1, in which case the getStatus() method can be queried to determine the cause of failure.

execute

public int execute(java.lang.Object Data,
                   int ArraySize)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
ArraySize - is the data array size associated with the Data object. This may be smaller than the actual size of the Data object, but NOT bigger.
Returns:
0 if successful otherwise a positive return code or -1, in which case the getStatus() method can be queried to determine the cause of failure.

attachLink

public int attachLink(java.lang.Object Data,
                      int ArraySize,
                      java.lang.Object DataEx,
                      int ArraySizeEx,
                      int identifier)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
ArraySize - is the data array size associated with the Data object. This may be smaller than the actual size of the Data object, but NOT bigger.
DataEx - is the extended data object and refers to the data object to which holds the input data to be sent to a server. Pass 'null' if no return data is desired.
ArraySizeEx - is the data array size associated with the DataEx object. This may be smaller than the actual size of the DataEx object, but NOT bigger.
identifier - is a user-specified integer identifier which is used to identify the link to the calling application. Following a receive() event, the application can call getLinkId() to retrieve this number. Other forms of AttachLink() will use the returned link handle as and identifier.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

attachLink

public int attachLink(java.lang.Object Data,
                      int ArraySize,
                      java.lang.Object DataEx,
                      int ArraySizeEx)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
ArraySize - is the data array size associated with the Data object. This may be smaller than the actual size of the Data object, but NOT bigger.
DataEx - is the extended data object and refers to the data object to which holds the input data to be sent to a server. Pass 'null' if no return data is desired.
ArraySizeEx - is the data array size associated with the DataEx object. This may be smaller than the actual size of the DataEx object, but NOT bigger.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

attachLink

public int attachLink(java.lang.Object Data,
                      java.lang.Object DataEx)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
DataEx - is the extended data object and refers to the data object to which holds the input data to be sent to a server. Pass 'null' if no return data is desired.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

attachLink

public int attachLink(java.lang.Object Data)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

attachLink

public int attachLink(java.lang.Object Data,
                      int ArraySize)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
ArraySize - is the data array size associated with the Data object. This may be smaller than the actual size of the Data object, but NOT bigger.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

attachLink

public int attachLink(java.lang.Object Data,
                      int ArraySize,
                      int identifier)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
ArraySize - is the data array size associated with the Data object. This may be smaller than the actual size of the Data object, but NOT bigger.
identifier - is a user-specified integer identifier which is used to identify the link to the calling application. Following a receive() event, the application can call getLinkId() to retrieve this number. Other forms of AttachLink() will use the returned link handle as and identifier.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

openLink

public int openLink(java.lang.Object Data,
                    int ArraySize,
                    java.lang.Object DataEx,
                    int ArraySizeEx,
                    int identifier)
Parameters:
currentLinkIdentifier - is the current link identifier of the data link to which the new link identifier is to be assigned. If not originally set by the initial call, it is the value returned by the initial call to AttachLink() or OpenLink().
linkIdentifier - is the desired link identifier to be associated with the data link defined by linkHandle.
Returns:
The link identifier associated with the data link. If de.desy.acop.chart is unable to set the link identifier to the new value, it remains unchanged. If successful, the new link handle will be set to the assigned link identifier. \b Example: \include eg_acopSetLinkIdentifier.java

openLink

public int openLink(java.lang.Object Data,
                    int ArraySize,
                    java.lang.Object DataEx,
                    int ArraySizeEx)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
ArraySize - is the data array size associated with the Data object. This may be smaller than the actual size of the Data object, but NOT bigger.
DataEx - is the extended data object and refers to the data object to which holds the input data to be sent to a server. Pass 'null' if no return data is desired.
ArraySizeEx - is the data array size associated with the DataEx object. This may be smaller than the actual size of the DataEx object, but NOT bigger.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

openLink

public int openLink(java.lang.Object Data,
                    java.lang.Object DataEx)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
DataEx - is the extended data object and refers to the data object to which holds the input data to be sent to a server. Pass 'null' if no return data is desired.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

openLink

public int openLink(java.lang.Object Data)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

openLink

public int openLink(java.lang.Object Data,
                    int ArraySize)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
ArraySize - is the data array size associated with the Data object. This may be smaller than the actual size of the Data object, but NOT bigger.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

openLink

public int openLink(java.lang.Object Data,
                    int ArraySize,
                    int identifier)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. Pass 'null' if no return data is desired.
ArraySize - is the data array size associated with the Data object. This may be smaller than the actual size of the Data object, but NOT bigger.
identifier - is a user-specified integer identifier which is used to identify the link to the calling application. Following a receive() event, the application can call getLinkId() to retrieve this number. Other forms of AttachLink() will use the returned link handle as and identifier.
Returns:
A positive link handle if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

getStatus

public java.lang.String getStatus(int hLink)

getStatusCode

public int getStatusCode(int hLink)

closeLink

public int closeLink(int hLink)
Parameters:
identifier - is the link handle of the acop data link which is to be terminated. If identifier == -1 then all associated links will be terminated.
Returns:
0 if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure. \b Example: \include eg_acopCloseLink1.java

getData

public int getData(java.lang.Object Data,
                   java.lang.Object DataEx,
                   int hLink)
Parameters:
Data - is the primary data object and refers to the data object to hold the output data returned from a server. This must be a reference to the same type of object passed in the original call to AttachLink() or OpenLink().
DataEx - is the extended data object and refers to the data object to which holds the input data to be sent to a server. This must be a reference to the same type of object passed in the original call to AttachLink() or OpenLink().
identifier - is the link handle of the data link which is to be terminated. If identifier == -1 then all associated links will be terminated.
Returns:
0 if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

acquireDisplayProperties

public int acquireDisplayProperties(Acop a,
                                    java.lang.String deviceContext,
                                    java.lang.String deviceGroup,
                                    java.lang.String deviceName,
                                    java.lang.String deviceProperty)

getXAxis

public double[] getXAxis(java.lang.Object data)

getYAxis

public double[] getYAxis(java.lang.Object data)

getXAxisChannelNames

public java.lang.String[] getXAxisChannelNames(java.lang.Object data)

getObjectSize

public int getObjectSize(java.lang.Object data)

getDataSize

public int getDataSize(int[] DataSize,
                       int[] DataSizeEx,
                       int hLink)
Parameters:
DataSize - is a reference to the current data size of primary Data object attached to the data link. As this is passed by reference, this must be an array of 1 integer. A 'null' can be passed if you are not interested in this value.
DataSizeEx - is a reference to the current data size of extended Data object attached to the data link. As this is passed by reference, this must be an array of 1 integer. A 'null' can be passed if you are not interested in this value.
identifier - is the link handle of the data link for which the current data sizes are desired.
Returns:
0 if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure. \b Example: \include eg_acopGetDataSize1.java

getDeviceContexts

public java.lang.String[] getDeviceContexts()
Returns:
A string array containing the device contexts

getDeviceGroups

public java.lang.String[] getDeviceGroups(java.lang.String deviceContext,
                                          java.lang.String deviceGroup,
                                          java.lang.String deviceName,
                                          java.lang.String deviceProperty)
Parameters:
deviceContext - is the device context for which the device groups are desired
deviceGroup - is the device group (sub-string + wildcards) for which the device groups are desired. 'null' is equivalent to "*".
deviceName - is the device name for which the device groups are desired. This parameter should typically passed as 'null'.
deviceProperty - is the device property for which the device groups are desired. This parameter should typically passed as 'null'.
Returns:
A string array containing the device groups

getDeviceGroups

public java.lang.String[] getDeviceGroups()
Returns:
A string array containing the device groups

getDeviceNames

public java.lang.String[] getDeviceNames(java.lang.String deviceContext,
                                         java.lang.String deviceGroup,
                                         java.lang.String deviceName,
                                         java.lang.String deviceProperty)
Parameters:
deviceContext - is the device context for which the device names are desired
deviceGroup - is the device group for which the device names are desired.
deviceName - is the device name (sub-string + wildcards) for which the device names are desired. 'null' is equivalent to "*".
deviceProperty - is the device property for which the device names are desired.
Returns:
A string array containing the device names

getDeviceNames

public java.lang.String[] getDeviceNames()
Returns:
A string array containing the device names

toTimeString

public java.lang.String toTimeString(int TimeStamp)

toTimeString

public java.lang.String toTimeString(double TimeStamp)

toTimeString

public java.lang.String toTimeString(java.util.Date TimeStamp)

setReceiveQueueDepth

public void setReceiveQueueDepth(int ReceiveQueueDepth)

setTimeStamp

public void setTimeStamp(int TimeStamp)

setTimeStamp

public void setTimeStamp(java.util.Date TimeStamp)

setTimeStamp

public void setTimeStamp(double TimeStamp)

getStatus

public java.lang.String getStatus()
Returns:
The current data status string

getGroupIndex

public int getGroupIndex()

setGrouped

public void setGrouped(boolean Grouped)
Parameters:
isGrouped - determines whether all data links associated with this acop are to fire one single event (isGrouped = true) when all link states have changed or not (isGrouped = false)

setDeviceContext

public void setDeviceContext(java.lang.String deviceContext)

getDeviceContext

public java.lang.String getDeviceContext()

setDeviceGroup

public void setDeviceGroup(java.lang.String deviceGroup)

getDeviceGroup

public java.lang.String getDeviceGroup()

setDeviceName

public void setDeviceName(java.lang.String deviceName)

getDeviceName

public java.lang.String getDeviceName()

setDeviceProperty

public void setDeviceProperty(java.lang.String deviceProperty)

getDeviceProperty

public java.lang.String getDeviceProperty()

setAccessMode

public void setAccessMode(AccessMode am)

getAccessMode

public AccessMode getAccessMode()

setAccessProtocol

public void setAccessProtocol(java.lang.String accessProtocol)

getAccessProtocol

public java.lang.String getAccessProtocol()

setAccessRate

public void setAccessRate(java.lang.String accessRate)

getAccessRate

public java.lang.String getAccessRate()

setPropertySize

public void setPropertySize(java.lang.String propertySize)

getPropertySize

public java.lang.String getPropertySize()

setAcopConfig

public void setAcopConfig(java.lang.String AcopConfig)

getAcopConfig

public java.lang.String getAcopConfig()

setLinkIdentifier

public int setLinkIdentifier(int currentLinkIdentifier,
                             int linkIdentifier)

getDataSize

public int getDataSize(int identifier)
Parameters:
identifier - is the link handle of the data link for which the current data sizes are desired.
Returns:
The data size of the returned data if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure. \b Example: \include eg_acopGetDataSize2.java

getDataSize

public int getDataSize()
Returns:
The data size of the returned data if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure. \b Example: \include eg_acopGetDataSize3.java

getDataSizeEx

public int getDataSizeEx(int identifier)
Parameters:
identifier - is the link handle of the data link for which the current data sizes are desired.
Returns:
The data size of the sent data if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

getDataSizeEx

public int getDataSizeEx()
Returns:
The data size of the sent data if successful otherwise -1, in which case the getStatus() method can be queried to determine the cause of failure.

getTimeStamp

public java.util.Date getTimeStamp()
Returns:
The current data time stamp as a Date object

getGrouped

public boolean getGrouped()
Returns:
the isGrouped state of this acop

getDeviceProperties

public java.lang.String[] getDeviceProperties()
Returns:
A string array containing the device properties

getDeviceProperties

public java.lang.String[] getDeviceProperties(java.lang.String deviceContext,
                                              java.lang.String deviceGroup,
                                              java.lang.String deviceName,
                                              java.lang.String deviceProperty)
Parameters:
deviceContext - is the device context for which the device properties are desired
deviceGroup - is the device group for which the device properties are desired.
deviceName - is the device name for which the device properties are desired.
deviceProperty - is the device property (sub-string + wildcards) for which the device properties are desired. 'null' is equivalent to "*".
Returns:
A string array containing the device properties

acquireDisplayProperties

public int acquireDisplayProperties(java.lang.String deviceContext,
                                    java.lang.String deviceGroup,
                                    java.lang.String deviceName,
                                    java.lang.String deviceProperty)
Parameters:
deviceContext - is the device context for which the device properties are desired
deviceGroup - is the device group for which the device properties are desired.
deviceName - is the device name for which the device properties are desired.
deviceProperty - is the device property (sub-string + wildcards) for which the device properties are desired. 'null' is equivalent to "*".
Returns:
0 if successful otherwise -1.

acquireDisplayProperties

public int acquireDisplayProperties()
Returns:
0 if successful otherwise -1.

addAcopTransportListener

public void addAcopTransportListener(AcopTransportListener l)

removeAcopTransportListener

public void removeAcopTransportListener(AcopTransportListener l)

getConnectionParameters

public ConnectionParameters getConnectionParameters()
Returns the connectionParameters.

Specified by:
getConnectionParameters in interface ConnectionParametersReceiver
Returns:
Returns the connectionParameters.

setConnectionParameters

public void setConnectionParameters(ConnectionParameters connectionParameters)
Sets new connectionParameters.

Specified by:
setConnectionParameters in interface ConnectionParametersReceiver
Parameters:
connectionParameters - The connectionParameters to set.

firePropertyChange

protected void firePropertyChange(java.lang.String propertyName,
                                  java.lang.Object oldValue,
                                  java.lang.Object newValue)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Description copied from interface: ConnectionParametersReceiver
Adds a PropertyChangeListener which listenes to all properties.

Specified by:
addPropertyChangeListener in interface ConnectionParametersReceiver
Parameters:
listener - the listener

addPropertyChangeListener

public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
Description copied from interface: ConnectionParametersReceiver
Adds a PropertyChangeListener to this receiver. Listener should receives notifications when the property with the name propertyName was changed.

Specified by:
addPropertyChangeListener in interface ConnectionParametersReceiver
Parameters:
propertyName - the name of the property which the listener listens
listener - the listener

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Description copied from interface: ConnectionParametersReceiver
Removes a PropertyChangeListener.

Specified by:
removePropertyChangeListener in interface ConnectionParametersReceiver

removePropertyChangeListener

public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
Description copied from interface: ConnectionParametersReceiver
Removes a PropertyChangeListener associated with the specified property.

Specified by:
removePropertyChangeListener in interface ConnectionParametersReceiver
Parameters:
propertyName - the name of the property which the listener listens
listener - the listener


Copyright © 2010. All Rights Reserved.