versadac  1
versadac - Scalable Recorder Firmware
am_historyend.h
1 /*****************************************************************************
2 FILE : am_historyend.h
3 VERSION : $Id $
4 AUTHOR : Sandra Herring
5 SYSTEM : GNU C++ for Power PC
6 DESCRIPTION : Class to read in a UHH end-of-file record.
7 *****************************************************************************/
8 
9 #if !defined(__AM_HISTORYEND_H)
10 #define __AM_HISTORYEND_H
11 
12 #if !defined(__AM_HISTORYRECORD_H)
13 #include "am_historyrecord.h"
14 #endif
15 
16 
18 {
19  public :
20 
21 /*------------------------------------------------------------------------------
22 FUNCTION : AM_HistoryEnd constructor
23 ARGUMENTS : None.
24 NOTES :
25 ------------------------------------------------------------------------------*/
26  AM_HistoryEnd();
27 
28 /*------------------------------------------------------------------------------
29 FUNCTION : AM_HistoryEnd destructor
30 NOTES :
31 ------------------------------------------------------------------------------*/
32  virtual ~AM_HistoryEnd();
33 
34  // virtual services inherited from class AM_HistoryRecord
35 
36  virtual sint32 read( AM_HistoryStream & stream );
37  virtual uint16 recordID();
38 
39 /*------------------------------------------------------------------------------
40 FUNCTION : AM_HistoryEnd::getEndTicks
41 DESCRIPTION : returns the archive file end time in ticks
42 ARGUMENTS : none.
43 RETURN : end time
44 NOTES :
45 ------------------------------------------------------------------------------*/
46  double getEndTicks();
47 
48  protected :
49  double m_EndTicks; // relative to file base year
50 
51 }; // class AM_HistoryEnd
52 
53 
54 // *************************************
55 // inline services for class Archive End
56 // *************************************
57 
58 /*------------------------------------------------------------------------------
59 FUNCTION : AM_HistoryEnd constructor
60 ARGUMENTS : None.
61 NOTES :
62 ------------------------------------------------------------------------------*/
63 inline AM_HistoryEnd::AM_HistoryEnd()
64  : m_EndTicks(0.0)
65 {}
66 
67 /*------------------------------------------------------------------------------
68 FUNCTION : AM_HistoryEnd destructor
69 NOTES :
70 ------------------------------------------------------------------------------*/
71 inline AM_HistoryEnd::~AM_HistoryEnd()
72 {}
73 
74 /*------------------------------------------------------------------------------
75 FUNCTION : AM_HistoryEnd::getEndTicks
76 DESCRIPTION : returns the archive file end time in ticks
77 ARGUMENTS : none.
78 RETURN : end time
79 NOTES :
80 ------------------------------------------------------------------------------*/
81 inline double AM_HistoryEnd::getEndTicks()
82 {
83  return m_EndTicks;
84 }
85 
86 #endif // end of __AM_HISTORYEND_H conditional include
87 
Definition: am_historyend.h:17
Definition: am_historystream.h:23
Definition: am_historyrecord.h:29