versadac  1
versadac - Scalable Recorder Firmware
ENUM_UhhMsg_Type.h
1 
2 /*
3 Enumerations for Uhh Message Interface
4 $Id: ENUM_UhhMsg_Type.h 4938 2006-10-10 14:20:18Z martinto $
5 */
6 
7 #ifndef __ENUM_UHHMSG_TYPE_H
8 #define __ENUM_UHHMSG_TYPE_H
9 
10 /* Message types */
11 
12 enum ENUM_UhhMsg_Type
13 {
14  /* Common types, applicable to all/some categories */
15  ENUM_UhhMsg_Type_None = 0, /* Not a valid message */
16  ENUM_UhhMsg_Type_Ping, /* Just see if anyone's there */
17  ENUM_UhhMsg_Type_Retry, /* Retry after BUF_SIZE_R error */
18 
19  /* Messages associated with specific categories */
20  ENUM_UhhMsg_Type_Specific = 16, /* Start of specific message types*/
21 
22  /* Messages to the interface itself */
23  ENUM_UhhMsg_Type_IF_GetVersion = ENUM_UhhMsg_Type_Specific,
24  /* Get the protocol version */
25  ENUM_UhhMsg_Type_IF_CreateNavMgr, /* Create the navigator manager */
26  ENUM_UhhMsg_Type_IF_CreateSktSrv, /* Create the socket server */
27  ENUM_UhhMsg_Type_IF_CreateBgRfsh, /* Create the background refresher */
28 
29  /* Messages to the navigation manager */
30  ENUM_UhhMsg_Type_NM_CreateNav = ENUM_UhhMsg_Type_Specific,
31  /* Create a new navigator */
32  ENUM_UhhMsg_Type_NM_DestroyNav, /* Destroy specified navigator */
33  ENUM_UhhMsg_Type_NM_DestroyJniNavs,/* Destroy all JNI navigators */
34  ENUM_UhhMsg_Type_NM_DestroySktNavs,/* Destroy JNI navigators on a socket */
35  ENUM_UhhMsg_Type_NM_RfshSuspHists, /* Refresh suspended histories */
36 
37  /* Messages to a navigator */
38 
39  /* Getting to a group */
40  ENUM_UhhMsg_Type_N_SetDirectory = ENUM_UhhMsg_Type_Specific,
41  /* Set navigation root directory */
42  ENUM_UhhMsg_Type_N_GetInstrNos, /* Get instrument numbers */
43  ENUM_UhhMsg_Type_N_SetInstrNo, /* Set instrument number */
44  ENUM_UhhMsg_Type_N_GetUhhSeqNos, /* Get UHH version sequence numbers */
45  ENUM_UhhMsg_Type_N_GetUhhSeqSup, /* Get max UHH ver seq no supported */
46  ENUM_UhhMsg_Type_N_SetUhhSeqNos, /* Set UHH version sequence number(s) */
47  ENUM_UhhMsg_Type_N_GetGroupNos, /* Get group numbers */
48  ENUM_UhhMsg_Type_N_Open, /* Open group for navigation */
49  ENUM_UhhMsg_Type_N_Close, /* Close current group */
50  /* Navigation modes */
51  ENUM_UhhMsg_Type_N_SetDirection, /* Set navigation direction */
52  ENUM_UhhMsg_Type_N_SetInterval, /* Set interval for GetNextItem */
53  ENUM_UhhMsg_Type_N_SetMessageMode, /* Set message mode */
54  ENUM_UhhMsg_Type_N_SetTraceMode, /* Set trace mode */
55  /* Pseudotime */
56  ENUM_UhhMsg_Type_N_GetEarliest, /* Get earliest pseudotime */
57  ENUM_UhhMsg_Type_N_GetEarliestSNP, /* As above limited to same no of pts */
58  ENUM_UhhMsg_Type_N_GetLatest, /* Get latest pseudotime */
59  ENUM_UhhMsg_Type_N_GetPseudotime, /* Get current pseudotime */
60  ENUM_UhhMsg_Type_N_SetEarliest, /* Jump to earliest pseudotime */
61  ENUM_UhhMsg_Type_N_SetLatest, /* Jump to latest pseudotime */
62  ENUM_UhhMsg_Type_N_SetPseudotime, /* Jump to specified pseudotime */
63  ENUM_UhhMsg_Type_N_PtimeToTime, /* Convert pseudotime to real time */
64  /* Refreshing etc. */
65  ENUM_UhhMsg_Type_N_Refresh, /* Refresh history */
66  ENUM_UhhMsg_Type_N_Suspend, /* Suspend. Enable background refresh. */
67  ENUM_UhhMsg_Type_N_Resume, /* Disable background refresh. Resume. */
68  /* Getting current segment header info */
69  ENUM_UhhMsg_Type_N_GetSegHdr, /* Get current segment header info */
70  ENUM_UhhMsg_Type_N_GetSegOther, /* Get segment header 'other' info */
71  ENUM_UhhMsg_Type_N_GetPointHdr, /* Get point header info */
72  ENUM_UhhMsg_Type_N_GetPointOther, /* Get point header 'other' info */
73  /* Getting data */
74  ENUM_UhhMsg_Type_N_GetNextItem, /* Get the next data item */
75  ENUM_UhhMsg_Type_N_GetNextItems, /* Get several next data items */
76  /* Debug */
77  ENUM_UhhMsg_Type_N_DbgHistSummary, /* Current group history summary */
78  /* Message only navigation */
79  ENUM_UhhMsg_Type_N_OpenForMessages, /* Open group for message navigation */
80  ENUM_UhhMsg_Type_N_SetMessageFilter, /* specify categories to filter on */
81  ENUM_UhhMsg_Type_N_GetNextMessage, /* actually retrieves the previous message item */
82  ENUM_UhhMsg_Type_N_SubtractClock, /* subtract clock period from a ptime */
83  /* Getting final recording status */
84  ENUM_UhhMsg_Type_N_GetFinalRecStat, /* Get final recording status */
85  /*Batch only navigation*/
86  ENUM_UhhMsg_Type_N_OpenForBatches, /* Open group for batch navigation */
87  ENUM_UhhMsg_Type_N_SetBatchMode, /* set batch mode */
88  ENUM_UhhMsg_Type_N_GetNextBatch, /* actually retrieves the previous batch item */
89  /* Getting current history header info */
90  ENUM_UhhMsg_Type_N_GetHistHdr, /* Get current history header info */
91  /* Step to the next segment */
92  ENUM_UhhMsg_Type_N_NextSeg, /* Steps to the next segment */
93  /* instruments */
94  ENUM_UhhMsg_Type_N_SetInstr, /* Set instrument */
95  ENUM_UhhMsg_Type_N_GetInstrs /* Get instruments */
96 
97  /* NB Add new navigator messages here, to leave existing codes unchanged */
98 };
99 
100 #endif /* __ENUM_UHHMSG_TYPE_H */