PSI sics-cvs-psi-2006

interface.tex

@@ -50,11 +50,13 @@ $\langle$obdes {\footnotesize ?}$\rangle\equiv$
 \mbox{}\verb@#ifndef SICSDESCRIPTOR@\\
 \mbox{}\verb@#define SICSDESCRIPTOR@\\
 \mbox{}\verb@#include <stdio.h>@\\
+\mbox{}\verb@#include <ifile.h>@\\
 \mbox{}\verb@@\\
 \mbox{}\verb@  typedef struct {@\\
 \mbox{}\verb@                   char *name;@\\
 \mbox{}\verb@                   int   (*SaveStatus)(void *self, char *name,FILE *fd);@\\
 \mbox{}\verb@                   void  *(*GetInterface)(void *self, int iInterfaceID);@\\
+\mbox{}\verb@                   IPair *pKeys;@\\
 \mbox{}\verb@                   } ObjectDescriptor, *pObjectDescriptor;@\\
 \mbox{}\verb@@\\
 \mbox{}\verb@ /*---------------------------------------------------------------------------*/@\\
@@ -143,9 +145,12 @@ $\langle$driv {\footnotesize ?}$\rangle\equiv$
 \mbox{}\verb@                   int   (*CheckStatus)(void *self, SConnection *pCon);@\\
 \mbox{}\verb@                   float  (*GetValue)(void *self, SConnection *pCon); @\\
 \mbox{}\verb@                   int iErrorCount;@\\
+\mbox{}\verb@                   int drivableStatus;@\\
 \mbox{}\verb@                   } IDrivable, *pIDrivable;@\\
 \mbox{}\verb@@\\
 \mbox{}\verb@        pIDrivable  GetDrivableInterface(void *pObject);                 @\\
+\mbox{}\verb@        int GetDrivablePosition(void *pObject, SConnection *pCon,@\\
+\mbox{}\verb@                                 float *fPos);@\\
 \mbox{}\verb@@\\
 \mbox{}\verb@@$\diamond$
 \end{list}
@@ -195,6 +200,10 @@ the existence of a drivable interface. If it exists a pointer to it will be
 returned. NEVER free this pointer. If no drivable interface exists, NULL
 will be returned.
 
+{\bf GetDrivablePosition retrieves the position of the drivabel
+object. If the device is a motor corrections for zero points and signs
+will be applied. Returns 1 on success and 0 on failure}
+
 \subsubsection{The Countable Interface}
 This is an interface for interacting with anything which counts.
 
@@ -272,7 +281,7 @@ $\langle$callfunc {\footnotesize ?}$\rangle\equiv$
 \mbox{}\verb@@\\
 \mbox{}\verb@   typedef void (*KillFuncIT)(void *pData);@\\
 \mbox{}\verb@   typedef int (*SICSCallBack)(int iEvent, void *pEventData, @\\
-\mbox{}\verb@                 void *pUserData);@\\
+\mbox{}\verb@                 void *pUserData, commandContext cc);@\\
 \mbox{}\verb@@$\diamond$
 \end{list}
 \vspace{-1ex}
@@ -312,7 +321,8 @@ $\langle$cifunc {\footnotesize ?}$\rangle\equiv$
 \mbox{}\verb@   int InvokeCallBack(pICallBack pInterface, int iEvent, void *pEventData); @\\
 \mbox{}\verb@@\\
 \mbox{}\verb@   /* callback client side */@\\
-\mbox{}\verb@   long RegisterCallback(pICallBack pInterface, int iEvent, SICSCallBack pFunc,@\\
+\mbox{}\verb@   long RegisterCallback(pICallBack pInterface, commandContext comCon, @\\
+\mbox{}\verb@                        int iEvent, SICSCallBack pFunc,@\\
 \mbox{}\verb@                        void *pUserData, KillFuncIT pKill);@\\
 \mbox{}\verb@   int RemoveCallback(pICallBack pInterface, long iID);@\\
 \mbox{}\verb@   int RemoveCallback2(pICallBack pInterface, void *pUserData);@\\
@@ -445,6 +455,16 @@ $\langle$envfunc {\footnotesize ?}$\rangle\equiv$
 \begin{list}{}{} \item
 \mbox{}\verb@@\\
 \mbox{}\verb@@$\langle$obdes {\footnotesize ?}$\rangle$\verb@@\\
+\mbox{}\verb@/*--------------------------------------------------------------------------*/@\\
+\mbox{}\verb@/* Additional properties used by the ANSTO site to provide more information@\\
+\mbox{}\verb@ * about each object instance, especially devices.@\\
+\mbox{}\verb@ */@\\
+\mbox{}\verb@  void SetDescriptorKey(pObjectDescriptor self, char *keyName, char *value);@\\
+\mbox{}\verb@  void SetDescriptorGroup(pObjectDescriptor self, char *group);@\\
+\mbox{}\verb@  void SetDescriptorDescription(pObjectDescriptor self, char *description);@\\
+\mbox{}\verb@  char * GetDescriptorKey(pObjectDescriptor self, char *keyName);@\\
+\mbox{}\verb@  char * GetDescriptorGroup(pObjectDescriptor self);@\\
+\mbox{}\verb@  char * GetDescriptorDescription(pObjectDescriptor self);@\\
 \mbox{}\verb@@$\diamond$
 \end{list}
 \vspace{-2ex}
@@ -472,6 +492,7 @@ $\langle$envfunc {\footnotesize ?}$\rangle\equiv$
 \mbox{}\verb@@\\
 \mbox{}\verb@#ifndef SICSINTERFACES@\\
 \mbox{}\verb@#define SICSINTERFACES@\\
+\mbox{}\verb@#include "commandcontext.h"@\\
 \mbox{}\verb@@\\
 \mbox{}\verb@/* interface ID's used to recognize an interface */@\\
 \mbox{}\verb@#define DRIVEID 513@\\