Initial revision

interface.h

@@ -0,0 +1,123 @@
+
+#line 343 "interface.w"
+
+/*---------------------------------------------------------------------------
+                        I N T E R F A C E S
+
+  Any object in SICS has to adhere to the object descriptor interface (see
+  file obdes.h). Furthermore SICS objects may choose to support other
+  interfaces as well. These interfaces are defined.
+
+  Mark Koennecke, June 1997
+
+  For more documentation see interface.w, interface.tex
+
+  copyright: see SICS impelementation files
+---------------------------------------------------------------------------*/
+
+#ifndef SICSINTERFACES
+#define SICSINTERFACES
+
+/* interface ID's used to recognize an interface */
+#define DRIVEID 513
+#define COUNTID 713
+#define CALLBACKINTERFACE 947
+#define ENVIRINTERFACE    949
+
+/* ----------------------- The drivable interface -----------------------*/
+
+#line 116 "interface.w"
+
+
+         typedef struct {
+                   int ID;
+                   int   (*Halt)(void *self);
+                   int   (*CheckLimits)(void *self, float fVal, 
+                              char *error, int iErrLen);
+                   long  (*SetValue)(void *self, SConnection *pCon,
+                                    float fVal);
+                   int   (*CheckStatus)(void *self, SConnection *pCon);
+                   float  (*GetValue)(void *self, SConnection *pCon); 
+                   int iErrorCount;
+                   } IDrivable, *pIDrivable;
+
+        pIDrivable  GetDrivableInterface(void *pObject);                 
+
+
+#line 368 "interface.w"
+
+
+   pIDrivable CreateDrivableInterface(void);
+
+/* ------------------------ The countable interface ---------------------*/
+
+#line 176 "interface.w"
+
+   typedef struct {
+                   int ID;
+                   int (*Halt)(void *self);
+                   int (*StartCount)(void *self, SConnection *pCon);
+                   int (*CheckCountStatus)(void *self, SConnection *pCon);
+                   int (*Pause)(void *self, SConnection *pCon);
+                   int (*Continue)(void *self, SConnection *pCon);
+                   int (*TransferData)(void *self, SConnection *pCon);
+                   } ICountable, *pICountable;
+
+        pICountable  GetCountableInterface(void *pObject);                 
+
+
+#line 373 "interface.w"
+
+
+   pICountable CreateCountableInterface(void);
+
+/* ------------------------- The CallBack Interface --------------------*/
+
+#line 227 "interface.w"
+
+   typedef void (*KillFuncIT)(void *pData);
+   typedef int (*SICSCallBack)(int iEvent, void *pEventData, 
+                 void *pUserData);
+
+#line 378 "interface.w"
+
+
+#line 249 "interface.w"
+
+   typedef struct __ICallBack *pICallBack;
+ 
+  /* event source side */
+   pICallBack CreateCallBackInterface(void);
+   void       DeleteCallBackInterface(pICallBack self);
+   int InvokeCallBack(pICallBack pInterface, int iEvent, void *pEventData); 
+
+   /* callback client side */
+   long RegisterCallback(pICallBack pInterface, int iEvent, SICSCallBack pFunc,
+                        void *pUserData, KillFuncIT pKill);
+   int RemoveCallback(pICallBack pInterface, long iID);
+   int RemoveCallback2(pICallBack pInterface, void *pUserData);
+
+#line 379 "interface.w"
+
+/*---------------------- The Environment Interface --------------------*/
+
+#line 307 "interface.w"
+
+        typedef enum { EVIdle, EVDrive, EVMonitor, EVError } EVMode;
+        typedef struct {
+                        int iID;
+                        EVMode (*GetMode)(void *self);
+                        int    (*IsInTolerance)(void *self);
+                        int    (*HandleError)(void *self);
+                       } EVInterface, *pEVInterface;
+
+#line 381 "interface.w"
+
+
+#line 333 "interface.w"
+
+   pEVInterface CreateEVInterface(void);
+
+#line 382 "interface.w"
+
+#endif