versadac  1
versadac - Scalable Recorder Firmware
am_historypvconfl.h
1 /*****************************************************************************
2 FILE : am_historypvconfl.h
3 VERSION : $Id: am_historypvconfl.h 4938 2006-10-10 14:20:18Z martinto $
4 AUTHOR : Sandra Herring
5 SYSTEM : GNU C++ for Power PC
6 DESCRIPTION : Header file for History PV Configuration list classes.
7 *****************************************************************************/
8 
9 #if !defined(__AM_HISTORYPVCONFL_H)
10 #define __AM_HISTORYPVCONFL_H
11 
12 #if !defined(__AM_HISTORYPVCONF_H)
13 #include "am_historypvconf.h"
14 #endif
15 
16 #if !defined(__LINKLIST_H)
17 #include "linklist.h"
18 #endif
19 
20 // ***************************************************************************
21 //
22 // History PV Configuration List Walker class
23 //
24 // ***************************************************************************
25 
27 {
28  public :
29 
30 /*------------------------------------------------------------------------------
31 FUNCTION : AM_HistoryPVConfigListWalker constructor
32 DESCRIPTION :
33 ARGUMENTS : Address of list to walk.
34  Type of PV to track, PV_TYPE_LIM if all.
35 RETURN : N/A
36 NOTES : positions walker at first item of specified type
37  or off top of list if PV_TYPE_LIM given.
38 ---------------------------------------------------------------------------*/
41  AM_HistoryPVConfig::HistoryPVType pvType =
42  AM_HistoryPVConfig::PV_TYPE_LIM );
43 
44  void trackType( AM_HistoryPVConfig::HistoryPVType pvType );
45 
46 /*---------------------------------------------------------------------------
47 FUNCTION : AM_HistoryPVConfigListWalker::first
48 DESCRIPTION : Method to position walker at first item of allocated PV type
49  in list.
50 ARGUMENTS : none.
51 RETURN : Pointer to item, or NULL if none of allocated type in list
52 NOTES :
53 ---------------------------------------------------------------------------*/
54  AM_HistoryPVConfig * first();
55 
56 /*---------------------------------------------------------------------------
57 FUNCTION : AM_HistoryPVConfigListWalker::next
58 DESCRIPTION : Method to position walker at next item of allocated type in list.
59 ARGUMENTS : none.
60 RETURN : Pointer to item, or NULL if none of allocated type in list.
61  If already at end of list, the walker is left at last item and
62  NULL is returned.
63 NOTES :
64 ---------------------------------------------------------------------------*/
65  AM_HistoryPVConfig * next();
66 
67  // attributes
68  private :
69  AM_HistoryPVConfig::HistoryPVType m_TrackPVType;
70 
71 }; // class AM_HistoryPVConfigListWalker
72 
73 #endif // conditional include __AM_HISTORYPVCONFL_H
74 
Definition: lists.h:307
Definition: am_historypvconf.h:24
Definition: am_historypvconfl.h:26