versadac  1
versadac - Scalable Recorder Firmware
am_historychan.h
1 /*****************************************************************************
2 FILE : am_historychan.h
3 VERSION : $Id: am_historychan.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 Channel class.
7 *****************************************************************************/
8 
9 #if !defined(__AM_HISTORYCHAN_H)
10 #define __AM_HISTORYCHAN_H
11 
12 #if !defined(__AM_HISTORYPVCONF_H)
13 #include "am_historypvconf.h"
14 #endif
15 
16 
17 // ***************************************************************************
18 // Channel configuration
19 // ***************************************************************************
20 
22 {
23  public :
24 
25  enum ChannelType
26  {
27  ANA_IN,
28  DIG_IN,
29  NETWORK_ANA_IN,
30  NETWORK_DIG_IN,
31  ANA_OUT
32  };
33 
34 /*------------------------------------------------------------------------------
35 FUNCTION : AM_HistoryChannelConfig constructor
36 DESCRIPTION :
37 ARGUMENTS : pvType : type of channel
38  dataType : type of value returned for this channel
39 RETURN : N/A
40 NOTES :
41 ------------------------------------------------------------------------------*/
42  AM_HistoryChannelConfig( PVType pvType,
43  uint8 dataType );
44 
45  // non-virtual services
46 
47  protected:
48 
49 /*------------------------------------------------------------------------------
50 FUNCTION : AM_HistoryChannelConfig::readAlarmTypes
51 DESCRIPTION : virtual service to read in configured alarm types
52  from current position in archive file.
53 ARGUMENTS : stream : pointer to open archive file stream.
54 RETURN : TRUE if data read in successfully, otherwise FALSE.
55 NOTES :
56 ------------------------------------------------------------------------------*/
57  sint32 readAlarmTypes( AM_HistoryStream & stream );
58 
59 /*---------------------------------------------------------------------------
60 FUNCTION : AM_HistoryChannelConfig::readGenericChannelHeader
61 DESCRIPTION : Reads a uhh file channel header record of any type, or a pkd real
62  channel header.
63 ARGUMENTS : stream : pointer to open archive file stream.
64 RETURN : TRUE if data read in successfully, otherwise FALSE.
65 NOTES :
66 ---------------------------------------------------------------------------*/
67  sint32 readGenericChannelHeader( AM_HistoryStream & stream );
68 
69  // attributes
70 
71  private :
72 
73 /*------------------------------------------------------------------------------
74 FUNCTION : AM_HistoryChannelConfig::readTrenduhh
75 DESCRIPTION : Service to read in trend member data values from uhh data file
76  from current position in file.
77 ARGUMENTS : stream : pointer to open file stream.
78 RETURN : TRUE if data read in successfully, otherwise FALSE.
79 NOTES :
80 ------------------------------------------------------------------------------*/
81  bool readTrenduhh( AM_HistoryStream & stream );
82 
83  uint16 m_AlarmType[4];
84  uint8 m_Type;
85 
86 }; // class AM_HistoryChannelConfig
87 
88 #endif // end of __AM_HISTORYCHAN_H conditional include
89 
Definition: am_historystream.h:23
Definition: am_historypvconf.h:24
Definition: am_historychan.h:21