versadac  1
versadac - Scalable Recorder Firmware
am_historybatchstop.h
1 /*****************************************************************************
2 FILE : am_historybatchstop.h
3 VERSION : $Id: am_historybatchstop.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 Batch Stop record.
7 *****************************************************************************/
8 
9 #if !defined(__AM_HISTORYBATCHSTOP_H)
10 #define __AM_HISTORYBATCHSTOP_H
11 
12 #if !defined(__AM_HISTORYRECORD_H)
13 #include "am_historyrecord.h"
14 #endif
15 
16 // ***************************************************************************
17 // Batch Header Stop Record class
18 // ***************************************************************************
19 
21 {
22  public :
23 
24 /*------------------------------------------------------------------------------
25 FUNCTION : AM_HistoryBatchStop constructor
26 DESCRIPTION :
27 ARGUMENTS : None.
28 RETURN : N/A
29 NOTES :
30 ------------------------------------------------------------------------------*/
32 
33 /*------------------------------------------------------------------------------
34 FUNCTION : AM_HistoryBatchStop destructor
35 DESCRIPTION :
36 ARGUMENTS : None.
37 RETURN : N/A
38 NOTES :
39 ------------------------------------------------------------------------------*/
40  virtual ~AM_HistoryBatchStop();
41 
42 /*------------------------------------------------------------------------------
43 FUNCTION : AM_HistoryBatchStop::getTicksSinceStart
44 DESCRIPTION : returns the batch stop time in ticks relative to the start record time
45 ARGUMENTS : none.
46 RETURN : batch stop time
47 NOTES :
48 ------------------------------------------------------------------------------*/
49  double getTicksSinceStart();
50 
51  // virtual services inherited from class AM_HistoryRecord, that must be supplied
52  // by derived type
53 
54  virtual sint32 read( AM_HistoryStream & stream );
55  virtual uint16 recordID();
56 
57  // non-virtual services
58 
59  private:
60  // start time in ticks rel to start record
61  double m_TicksSinceStart;
62 
63 }; // class AM_HistoryBatchStop
64 
65 
66 // ****************************************
67 // inline services for class Batch Header
68 // ****************************************
69 
70 /*------------------------------------------------------------------------------
71 FUNCTION : AM_HistoryBatchStop constructor
72 DESCRIPTION :
73 ARGUMENTS : None.
74 RETURN : N/A
75 NOTES :
76 ------------------------------------------------------------------------------*/
77 inline AM_HistoryBatchStop::AM_HistoryBatchStop()
78  : m_TicksSinceStart(0.0)
79 {}
80 
81 /*------------------------------------------------------------------------------
82 FUNCTION : AM_HistoryBatchStop destructor
83 DESCRIPTION :
84 ARGUMENTS : None.
85 RETURN : N/A
86 NOTES :
87 ------------------------------------------------------------------------------*/
88 inline AM_HistoryBatchStop::~AM_HistoryBatchStop()
89 {}
90 
91 /*------------------------------------------------------------------------------
92 FUNCTION : AM_HistoryBatchStop::getTicksSinceStart
93 DESCRIPTION : returns the batch stop time in ticks relative to the start record time
94 ARGUMENTS : none.
95 RETURN : batch stop time
96 NOTES :
97 ------------------------------------------------------------------------------*/
98 inline double AM_HistoryBatchStop::getTicksSinceStart()
99 {
100  return m_TicksSinceStart;
101 }
102 
103 #endif
104 
Definition: am_historystream.h:23
Definition: am_historybatchstop.h:20
Definition: am_historyrecord.h:29