F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Timer.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title Timer.hpp
3 // \author Brian Campuzano
4 // \brief hpp file for CFDP timer that is driven by
5 // ======================================================================
6 
7 #ifndef CCSDS_CFDPTIMER_HPP
8 #define CCSDS_CFDPTIMER_HPP
9 
10 #include <Fw/FPrimeBasicTypes.hpp>
11 
12 namespace Svc {
13 namespace Ccsds {
14 namespace Cfdp {
15 
16 class Timer {
17  // ----------------------------------------------------------------------
18  // Class types
19  // ----------------------------------------------------------------------
20  public:
22 
23  public:
24  // ----------------------------------------------------------------------
25  // Class construction and destruction
26  // ----------------------------------------------------------------------
27 
29  Timer();
30 
32  ~Timer();
33 
34  public:
35  // ----------------------------------------------------------------------
36  // Class interfaces
37  // ----------------------------------------------------------------------
38 
40  void setTimer(U32 timerDuration
41  );
42 
44  void disableTimer(void);
45 
47  Status getStatus(void);
48 
50  void run(void);
51 
52  private:
53  // ----------------------------------------------------------------------
54  // Class member variables
55  // ----------------------------------------------------------------------
56 
58  Status timerStatus;
59 
61  U32 secondsRemaining;
62 };
63 
64 } // namespace Cfdp
65 } // namespace Ccsds
66 } // namespace Svc
67 
68 #endif // CCSDS_CFDPTIMER_HPP
void disableTimer(void)
Disables a CFDP timer.
Definition: Timer.cpp:32
Timer()
Construct Timer object.
Definition: Timer.cpp:19
Status getStatus(void)
Get the status of a CFDP timer.
Definition: Timer.cpp:37
void setTimer(U32 timerDuration)
Initialize a CFDP timer and start its execution.
Definition: Timer.cpp:27
~Timer()
Destroy Timer object.
Definition: Timer.cpp:21
void run(void)
Runs a one second increment of the CFDP timers.
Definition: Timer.cpp:41
RateGroupDivider component implementation.