---

probeComm.h File Reference

#include "lsfTaskDev.h"
#include "acm.h"

Include dependency graph for probeComm.h:

Go to the source code of this file.

Probe Comm task.
The Comm task acts as a synchronisation and coordination task between the sendrefs loop and the probe tracking loop.
#define	probeCOMM_TASK   "comm"
ccsCOMPL_STAT	probeCommConstructor (ccsERROR *error)
ccsCOMPL_STAT	probeCommDestructor (ccsERROR *error)
ccsCOMPL_STAT	probeComm (const lsfTASKDEV_DATA *taskDevData, const char *taskDevName, ccsERROR *error)
ccsCOMPL_STAT	probeCommProHook (const lsfTASKDEV_DATA *taskDevData, const char *taskDevName, ccsERROR *error)
ccsCOMPL_STAT	probeCommEpiHook (const lsfTASKDEV_DATA *taskDevData, const char *taskDevName, ccsERROR *error)
ccsCOMPL_STAT	probeCommNewReference (ccsERROR *error)
ccsCOMPL_STAT	probeCommProtectComm (ccsERROR *error)
void	probeCommUnProtectComm ()
void	probeCommSetNewPreset (const vltLOGICAL newPreset)
vltLOGICAL	probeCommGetNewPreset ()
ccsCOMPL_STAT	probeCommSetGpInPos (const vltLOGICAL gpInPos, ccsERROR *error)
vltLOGICAL	probeCommGetGpInPos ()
ccsCOMPL_STAT	probeCommUpdRef (acmSEND_REFS_SET_POINTS setPoints, const ccsTIMEVAL timeStamp, ccsERROR *error)
ccsCOMPL_STAT	probeCommGetRef (acmSEND_REFS_SET_POINTS *setPoints, ccsTIMEVAL *timeStamp, ccsERROR *error)

---

Define Documentation

#define probeCOMM_TASK   "comm"

---

Function Documentation

ccsCOMPL_STAT probeCommConstructor (  ccsERROR *    error )

C'tor.

ccsCOMPL_STAT probeCommDestructor (  ccsERROR *    error )

D'tor.

ccsCOMPL_STAT probeComm (  const lsfTASKDEV_DATA *    taskDevData, const char *    taskDevName, ccsERROR *    error )

Main loop of probe monitor task

ccsCOMPL_STAT probeCommProHook (  const lsfTASKDEV_DATA *    taskDevData, const char *    taskDevName, ccsERROR *    error )

Prolog function hook for probe monitor task

ccsCOMPL_STAT probeCommEpiHook (  const lsfTASKDEV_DATA *    taskDevData, const char *    taskDevName, ccsERROR *    error )

Epilog function hook for probe monitor task

ccsCOMPL_STAT probeCommNewReference (  ccsERROR *    error )

Notification of new reference position. This function must be called by the sendRefs function when there is a new reference position (offset, preset) is available. It just triggers the GpInPos task and therefore is non-blocking for the calling function.

ccsCOMPL_STAT probeCommProtectComm (  ccsERROR *    error )

Protect access, modify function calls. The function has to be called to safely call any of the access, modify functions. See also: probeGpInPosUnProtectGpInPos, probeGpInPosSetNewPreset, probeGpInPosGetNewPreset, probeGpInPosSetGpInPos, probeGpInPosGetGpInPos

void probeCommUnProtectComm (    )

Unprotect access, modify function calls. The function must be called to allow other process to gain access to the GpInPos variables

void probeCommSetNewPreset (  const vltLOGICAL    newPreset )

Set Preset/Offset flag. It is set by the Comm task if a new target reference is available and signal that to the probe tracking task.

vltLOGICAL probeCommGetNewPreset (    )

Get Preset/Offset flag.

ccsCOMPL_STAT probeCommSetGpInPos (  const vltLOGICAL    gpInPos, ccsERROR *    error )

Set guide probe in position flag. This flag is set when the guide probe is in position. It is cleared by the Comm task when a new reference is available

vltLOGICAL probeCommGetGpInPos (    )

Get guide probe in position flag.

ccsCOMPL_STAT probeCommUpdRef (  acmSEND_REFS_SET_POINTS    setPoints, const ccsTIMEVAL    timeStamp, ccsERROR *    error )

Notification that a new set of references are available. The probeComm task keeps a copy of the trk sendrefs references for usage within the probe software. This is done in order to decouple the trk loop from the probe loop. The access to these data is semaphore protected to allow access to a consistent set of references with a defined time stamp. This function updates the internal copy of the data and is called by the probeSendRefs function.

ccsCOMPL_STAT probeCommGetRef (  acmSEND_REFS_SET_POINTS *    setPoints, ccsTIMEVAL *    timeStamp, ccsERROR *    error )

Retrieve last pair of setPoints and the time stamp. The access is semaphore protected and garantees a consistent set of data. See also: probeCommUpdRef

---