All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.arcsinc.hardwarehost.datamgmt.ClientDataMgrImpl

java.lang.Object
   |
   +----com.arcsinc.hardwarehost.datamgmt.ClientDataMgrImpl

public class ClientDataMgrImpl
extends Object
implements ClientDataMgr, Runnable

The ClientDataMgrImpl class is the ARCSware standard implementation of the ClientDataMgr interface. This class sends data to its DataClient and the DataClient object controls when it receives data and how frequently in receives data via the member functions of this class.

See Also:: ClientClientDataMgr.html#_top_">ClientDataMgr, ExtVariableSpec

addMonitoredParameter(ExtVariableSpec): Adds an individual parameter for monitoring.
enableOnLineLogging(boolean): Requests that on-line monitoring is started or stopped.
getAvailParams(): Returns a Vector of the available parameters.
getCurrentApp(): Returns the name of the current application.
getHostName(): Returns the host name.
getMonitoredParameters(): Gets the parameters currently being monitored.
getOnLineLoggingPeriod(): Gets the time between data refreshing by the manager.
getParameters(Vector): The data client uses this function to do a one time get of the parameters requested.
removeMonitoredParameter(ExtVariableSpec): Removes an individual parameter from monitoring.
run(): Utility function which retrieves data from the HostDataMgr and send it to the client
setMonitoredParameters(Vector): Sets the parameters which a client desires to monitor (on-line).
setOnLineLoggingPeriod(int): Sets the requested time between data refreshing by the manager.

run

 public void run()

Utility function which retrieves data from the HostDataMgr and send it to the client

getHostName

 public String getHostName()

Returns the host name. Currently, this function only returns ly, this function only returns "local".

Returns:: a String with the host name.

getCurrentApp

 public String getCurrentApp()

Returns the name of the current application.

Returns:: a String with the current application name.

getAvailParams

 public Vector getAvailParams()

Returns a Vector of the available parameters. The objects stored in the in the Vector are of type ExtVariableSpec.

Returns:: a Vector of ExtVariableSpec objects

setMonitoredParameters

 public boolean setMonitoredParameters(Vector params)

Sets the parameters which a client desires to monitor (on-line).

Parameters:: params - Vector of ExtVariableSpec(s) of ExtVariableSpec(s) which denote the desired parameters for monitoring.
Returns:: true if monitoring of parameters was successfully established, otherwise, false

getOnLineLoggingPeriod

 public int getOnLineLoggingPeriod()

Gets the time between data refreshing by the manager.

Returns:: the time between data refreshing in milliseconds.

setOnLineLoggingPeriod

 public 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 to use the data acquisition system features. Also, there is a minimum time which will be accepted, @see com.arcsinc.hardwarehost.datamgmt.HostDataMgrImpl

Parameters:: milliseconds - time between updates.
Returns:: true is successfully called and desired time is accepted.

enableOnLineLogging

 public boolean enableOnLineLogging(boolean v)

Requests that on-line monitoring is started or stopped. Called with true, the manager wiler 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.

getMonitoredParameters

 public Vector getMonitoredParameters()

Gets the parameters currently being monitored.

Returns:: Vector of ExtVariableSpec(s) which are set to be monitored.

addMonitoredParameter

 public boolean addMonitoredParameter(ExtVariableSpec param)

Adds an individual parameter for monitoring. This function is not currently implemented.

Parameters:: param - to add to the list of monitored parameters.
Returns:: true if requested parameters was successfully added, otherwise, essfully added, otherwise, false



removeMonitoredParameter
 public boolean removeMonitoredParameter(ExtVariableSpec param)


   Removes an individual parameter from monitoring.  This function
 is not currently implemented.

  

     Parameters:
    
 param - to remove  - to remove from the list of monitored parameters.
    
 Returns:
    
 true if requested parameters was successfully
 removed, otherwise, false
  


getParameters
 public boolean getParameters(Vector params)


   The data client uses this function to do a one time get of the
 parameters requested.  This function is not currently implemented.

  

     Parameters:
    
 params - is a Vector of
 ExtVariableSpec(s) which denote the desired parameters.
    
 Returns:
    
 true if request was successfully completed,
 otherwise, false.
  


All Packages  Class Hierarchy  This Package  Previous  Next  Index


/pre>