All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.arcsinc.hardwarehost.HdwMgr

public interface HdwMgr
The HdwMgr interface provides the main practical interface for interaction with the system.

See Also:
DataAcqClient, DataAcqMgr

Variable Index

o KERNEL
The KERNEL constant indicates that the hardware is running the on-board kernel program.
o LOAt=" o "> LOADING
The LOADING constant indicates that the hardware running the kernel and in the process of downloading an application program.
o RUNNING
The RUNNING constant indicates that the hardware is running an application program.
o UNKNOWN
The UNKNOWN constant indicates that the hardware can be running any application program, the kernel, or complr completely broken; no assumptions will be made.

Method Index

o addHdwListener(HdwListener)
Adds a HdwListener
o addRemoteConnection(String, String)
Establish a connection to the
o downloadApp()
Download the current App to the hardware.
o establishLinkage(Integer, ExtVariableSpec[])
o getAvailableApps()
Get a list of the available applications.
o getControllerState()
Get the controller state.
o getCurrentApp()
Get the value of currentApp (name only).
o getDataAcqMgr(DataAcqClient)
Gets a reference to the DataAcqMgr
o getParams(Vector)
Get symbol value(s) in the application currently running on the controller.
o getRemoteDataSpec(Integer)
o getVerifyMessages(int, int)
Returns the appropriate message associated with a call to verifyComm().
o isAppNameOpen(String)
Determine if an application is in the available list.
o isCommWorking()
Determine if communications to the hardware is functioning.
o height=6 alt=" o "> pauseCntlr()
Command the application to suspend (pause) execution of the current application.
o rebootHdw()
Force the hardware to reboot, including all actions leading to reboot.
o registerApp(String, byte[], float)
Register an application in the available list.
o removeApp(String)
Remove an app.
o removeHdwListener(HdwListener)
Removes a HdwListener
o removeRemoteConnection(Integer)
o resumeCntlr()
Command the application to resume execution (following a pauseCntlr () of the current application.
o setAsynchronous(Integer)
o setCurrentApp(String)
Set the value of currentApp.
o setParams(Vector)
Set the controller params.
o setSynchronous(Integer, ExtVariableSpec)
o startCntlr()
Command the downloaded application to be started.
o stopCntlr()
Command the application to stop.
o updateApp(String, byte[], float)
Update an application.
o verifyComm(int)
Provides a more detailed evaluation of the hardware common of the hardware communications.

Variables

o UNKNOWN 
 public static final int UNKNOWN
The UNKNOW> The UNKNOWN constant indicates that the hardware can be running any application program, the kernel, or completely broken; no assumptions will be made.

o KERNEL 
 public static final int KERNEL
The KERNEL constant indicates that the hardware is running the on-board kernel program.

o LOADING 
 public static final int LOADING
The LOADING constant indicates that the hardware running the kernel and in the process of downloading an application program.

o RUNNING 
 public static final int RUNNING
The RUNNING constant indicates that the hardware is running an application program.

Methods

o addHdwListener 
 public abstract void addHdwListener(HdwListener listener)
Adds a HdwListener

de>HdwListener

Parameters:
listener - HdwListener to be added.
o removeHdwListener 
 public abstract void removeHdwListener(HdwListener listener)
Removes a HdwListener

Parameters:
listener - HdwListener to be r to be removed.
o isAppNameOpen 
 public abstract boolean isAppNameOpen(String v)
Determine if an application is in the available list.

Parameters:
v - Value to check.
Returns:
True if application is available.
o registerApp 
 public abstract boolean registerApp(String v,
                                     byte outFile[],
                                     float period)
Register an application in the available list.

Parameters:
v - Value to register.
outFile - Contains the coff file.
period - Base time period (sec) for the app.
Returns:
App successfully registered.
o updateApp 
 public abstract boolean updateApp(String v,
                                   byte outFile[],
                                   float peri                                float period)
Update an application. If application has not be previously registered, an attempt is made to register the app.

Parameters:
v - Value to register.
outFile - Contains the coff file.
period - Base time period (sec) for the app.
Returns:
App successfully updated.
o removeApp 
 public abstract boolean removeAp boolean removeApp(String v)
Remove an app. Note, this app cannot be the currentApp.

Parameters:
v - App to be removed from the available list.
Returns:
App successfully removed.
o setCurrentApp 
 public abstract boolean setCurrentApp(String v)
Set the value of currentApp.

Parameters:
v - Value to assign to currentApp.
Returns:
App successfully made currentApp.
o getCurrentApp 
 public abstract String getCurrentApp()
Get the value of currentApp (name only).

Returns:
Name of the currentApp.
o getAvailableApps 
 public abstract String[] getAvailableApps()
Get a list of the available applications.

Returns:
Value of available applications.
o rebootHdw 
 public abstract boolean rebootHdw()
Force the hardware to reboot, including all actions leading to reboot. Other actions may include general reset and host communications re-initialization.

Returns:
true reboot was successful.
o downloadAppdownloadApp 
 public abstract boolean downloadApp()
Download the current App to the hardware.

Returns:
true if download completed by the host (does not indicate that the program was successful in running.
o startCntlr 
 public abstract boolean startCntlr()
Command the downloaded application to be started.

Returns:
true if successful, otherwise false.
o stopCntlr 
 public abstract boolean stopCntlr()
Command the application to stop.

Returns:
true if successful, otherwise false.
o pauseCntlr 
 public abstract boolean pauseCntlr()
Command the application to suspend (pause) execution of the current application. Note, communications is still available.

Returns:
true if successful, otherwise fdd> true if successful, otherwise false.
o resumeCntlr 
 public abstract boolean resumeCntlr()
Command the application to resume execution (following a pauseCntlr () of the current application. Note, communications is still available.

Returns:
true if successful, otherwise false.
o isCommWorking 
 public abstract boolean isCommWorking()
Determine if communications to the hardware is functioning.

Returns:
true if the hardware responses to communications.
o verifyComm 
 public abstract int verifyComm(int level)
Provides a more detailed evaluation of the hardware communications. See @see com.arcsinc.hardwarehost.PhysHdwCommImpl

Parameters:
level - throughness of diagnostic
Returns:
result code
o getVerifyMessages 
 public abstract String[] getVerifyMessages(int level,
                                            int code)
Returns the appropriate message associated with a call to verifyComm().

Returns:
the message
o setParams 
 public absams">setParams

 public abstract boolean setParams(Vector params)




  
 Set the controller params.


  

    
 Parameters:
    
 params - a Vector of ExtVariableSpec
 objects which hold symbol references and the values which are
 to be set.
    
 Returns:
    
 true is successfully completed.
  



 o 
getParams

 public abstract Vector getParams(Vecr getParams(Vector params)




  
 Get symbol value(s) in the application currently running on
 the controller.  Note, values are returned in params.


  

    
 Parameters:
    
 params - a Vector of ExtVariableSpec
 objects which hold symbol references.
 to be set.
    
 Returns:
    
 Vector with the parameters' values.
  



 o 
getControllerState

 public abstract int getControllerState()




  
 Get the controller state.


  

    
 Returns:
    
 the current controller state
  



 o 
getDataAcqMgr

 public abstract DataAcqMgr getDataAcqMgr(DataAcqClient client)




  
 Gets a reference to the DataAcqMgr


  

    
 Parameters:
    
 client - a DataAcqClient to attach to the
 manager
    
 Returns:
    
 the DataAcqMgr
  




  

 o 
addRemoteConnection

 public abstract Integer addRemoteConnection(String rHostName,
                                             String rObjName)




  
 Establish a connection to the @param rObjName (RemoteNodeServer) 
 on the @param rHostName.


  

    
 Returns:
    
 Object refernce to this connection
  



 o 
removeRemoteConnection

 public abstract boolean removeRemoteConnection(Integer remoteRef)


 o 
setSynchronous

 public abstract boolean setSynchronous(Integer remoteRef,
                                        ExtVariableSpec syncVar)


 o 
setAsynchronous

 public abstract boolean setAsynchronous(Integer remoteRef)


 o 
establishLinkage

 public abstract boolean establishLinkage(Integer remoteRef,
                                          ExtVariableSpec connectionVariable[])


 o 

getRemoteDataSpec

 public abstract Vector getRemoteDataSpec(Integer remoteRef)





All Packages  Class Hierarchy  This Package  Previous  Next  Index