org.jlab.coda.afecs.client
Class AClient

java.lang.Object
  extended by org.jlab.coda.afecs.system.ABase
      extended by org.jlab.coda.afecs.agent.AAParent
          extended by org.jlab.coda.afecs.client.AClient

public abstract class AClient
extends AAParent

JSA: Thomas Jefferson National Accelerator Facility
This software was developed under a United States Government license,
described in the NOTICE file included as part of this distribution.
This is the base class for the user components that does not use COOL description. The thing must be defined in COOL in order to make this client part of the control are: Client name, and states with only state names defiend. Copyright (c), Apr 29, 2011


Field Summary
 
Fields inherited from class org.jlab.coda.afecs.agent.AAParent
isAborting, isResetting, isTransitioning, me, myPlugin, pm, strpT
 
Fields inherited from class org.jlab.coda.afecs.system.ABase
myConfig, myCRCClientConnection, myName, myPlatformConnection, myRcDomainConnection
 
Constructor Summary
AClient(java.lang.String name)
           
 
Method Summary
abstract  boolean cL_abort()
           
abstract  void cL_execProcess()
           
abstract  java.lang.String cL_getDescription()
           
abstract  int cL_getErrorCode()
           
abstract  java.lang.String cL_getState()
           
abstract  java.lang.String cL_getStatus()
           
abstract  java.lang.String cL_getSuggestedAction(int errorCode)
           
abstract  java.lang.String cL_getType()
           
abstract  boolean cL_move2State(java.lang.String stateName)
           
abstract  boolean cL_reset()
           
abstract  boolean cL_setup()
           
abstract  void cL_startReporting()
           
abstract  void cL_stopReporting()
           
 
Methods inherited from class org.jlab.coda.afecs.agent.AAParent
differentiate, moveToState, startLoadReporting, startProcess, startStatusReporting, stop_rpp, stopLoadReporting, stopStatusReporting, update_registration
 
Methods inherited from class org.jlab.coda.afecs.system.ABase
B2O, codaInfoGetCodaClass, codaInfoGetObjectType, codaInfoGetState, codaInfoGetStatus, codaInfoSyncGetCodaClass, codaInfoSyncGetObjectType, codaInfoSyncGetStatus, connect, connect, connect, dalogMsg, dalogMsg, disconnect, getCurrentTime, getCurrentTime, getCurrentTimeInMs, getPlDescription, getPlEXPID, getPlMulticastUDL, getPlUDL, isConnected, isNumber, isRcClientConnected, msg2xml, msgForward, multicastConnect, multicastConnect, O2B, p2pSend, p2pSend, p2pSend, p2pSend, rcClientConnect, rcClientDisconnect, rcClientInfoSyncGetState, rcConnect, rcMonitor, rcp2pSend, rcp2pSend, rcSend, rcSend, rcSend, rcSend, rcSend, rcSend, rcSend, rcSend, readFileAsString, removeUnixShellProcess, reporAlarmMsg, reportAlarmMsg, reportAlarmMsg, runControlGetConfigId, runControlGetRunNumber, runControlGetRunType, runControlSetRunNumber, runControlSetRunType, runControlSyncGetRunNumber, runControlSyncGetRunType, runShellCommand, send, send, send, send, send, send, send, sessionControlConfigure, sessionControlExit, sessionControlGetSession, sessionControlSetInterval, sessionControlSetSession, sessionControlSetState, sessionControlStartReporting, sessionControlStopReporting, sessionControlSyncGetSession, sleep, updateHostUdl
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AClient

public AClient(java.lang.String name)
Method Detail

cL_setup

public abstract boolean cL_setup()

cL_move2State

public abstract boolean cL_move2State(java.lang.String stateName)

cL_getState

public abstract java.lang.String cL_getState()

cL_getStatus

public abstract java.lang.String cL_getStatus()

cL_getDescription

public abstract java.lang.String cL_getDescription()

cL_getType

public abstract java.lang.String cL_getType()

cL_getErrorCode

public abstract int cL_getErrorCode()

cL_getSuggestedAction

public abstract java.lang.String cL_getSuggestedAction(int errorCode)

cL_execProcess

public abstract void cL_execProcess()

cL_startReporting

public abstract void cL_startReporting()

cL_stopReporting

public abstract void cL_stopReporting()

cL_reset

public abstract boolean cL_reset()

cL_abort

public abstract boolean cL_abort()