All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.arcsinc.hardwarehost.datamgmt.ClientDataMgr

public interface ClientDataMgr
extends AbsDataMgr
The ClientDataMgr interface provides the required functions needed by a DataClient for control of the client's on-line monitoring function. An instantance of ClientDataMgr can only serve one DataClient.

See Also:
AbsDataMgr, ExtVariableSpec

Method Index height=38 alt="Method Index">

o addMonitoredParameter(ExtVariableSpec)
Adds an individual parameter for monitoring.
o enableOnLineLogging(boolean)
Requests that on-line monitoring is started or stopped.
o getMonitoredParameters()
Gets the parameters currently being monitored.
o getOnLineLoggingPeriod()
Gets the time between data refreshing by the manager.
o getParameters(Vector)
The data client uses this function to do a one time get of the parameters requested.
o removeMonitoredParameter(ExtVariableSpec)
Removes an individual parameter from monitoring.
o setMonitoredParameters(Vector)
Sets the parameters which a client desires to monitor (on-line).
o setOnLineLoggingPeriod(int)
Sets the requested time between data refreshing by the manager.

Methods

o setMonitoredParameters 
 public abstract boolean setMonitoredParameters(Vector params)
Sets the parameters which a client desires to monitor (on-line).

Parameters:
params - Vector of ExtVariableSpec(s) which denote the desired parameters for monitoring.
Returns:
true if monitoring of parameters was successfully established, otherwise, false
o getMonitoredParameters 
 public abstract Vector getMonitoredParameters()
Gets the parameters currently being monitored.

Returns:
Vector of ExtVariableSpec(s) which are set to be monitored.
o addMonitoredParameter 
 public abstract boolean addMonitoredParameter(ExtVariableSpec param)
param)
Adds an individual parameter for monitoring.

Parameters:
param - add it to the list of monitored parameters.
Returns:
true if requested parameters was successfully added, otherwise, false
o removeMonitoredParameter 
 public abstract boolean removeMonitoredParameter(ExtVariableSpec param)
Removes an individual parameter from monitoring.

Parameters:
param - remove it from the list of monitored parameters.
Returns:
true if requested parameters was successfully removed, otherwise, false
o getParameters 
 public abstract boolean getParameters(Vector params)
The data client uses this function to do a one time get of the parameters requested. The values may be returned through the normal on-line call to the DataClient interface de>DataClient interface or through the Vector calling argument.

Parameters:
params - Vector of ExtVariableSpec(s) on which a one-time get is to be performed.
Returns:
true if request was successfully completed, otherwise, false.
o enableOnLineLogging 
 public abstract boolean enableOnLineLogging(boolean v)
Requests that on-line monitoring is started or stopped. Called with true, the manager will send data to the client. Called with false, the manager will cease to send data.

Parameters:
v - true to send data or false to stop sending data.
Returns:
true if call was successful.
o setOnLineLoggingPeriod 
 public abstract boolean setOnLineLoggingPeriod(int milliseconds)
Sets the requested time between data refreshing by the manager. Note, the timing function is "soft". For precisely timed data, it is necessary totimed data, it is necessary to use the data acquisition system features.

Parameters:
milliseconds - requested time between updates.
Returns:
true is successfully called and desired time is accepted.
o getOnLineLoggingPeriod 
 public abstract int getOnLineLoggingPeriod()
Gets the time between data refreshing by the manager.

Returns:
the time between data refreshing in milliseconds. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index