F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
PosixTimeComponentAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title PosixTimeComponentAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for PosixTime component base class
5 // ======================================================================
6 
7 #ifndef Svc_PosixTimeComponentAc_HPP
8 #define Svc_PosixTimeComponentAc_HPP
9 
10 #include "FpConfig.hpp"
14 #include "Fw/Time/TimePortAc.hpp"
15 
16 namespace Svc {
17 
24  {
25 
26  // ----------------------------------------------------------------------
27  // Friend classes
28  // ----------------------------------------------------------------------
29 
32 
33  PROTECTED:
34 
35  // ----------------------------------------------------------------------
36  // Constants
37  // ----------------------------------------------------------------------
38 
40  enum {
42  };
43 
44  public:
45 
46  // ----------------------------------------------------------------------
47  // Component initialization
48  // ----------------------------------------------------------------------
49 
51  void init(
52  FwEnumStoreType instance = 0
53  );
54 
55  public:
56 
57  // ----------------------------------------------------------------------
58  // Getters for typed input ports
59  // ----------------------------------------------------------------------
60 
65  FwIndexType portNum
66  );
67 
68  PROTECTED:
69 
70  // ----------------------------------------------------------------------
71  // Component construction and destruction
72  // ----------------------------------------------------------------------
73 
76  const char* compName = ""
77  );
78 
80  virtual ~PosixTimeComponentBase();
81 
82  PROTECTED:
83 
84  // ----------------------------------------------------------------------
85  // Getters for numbers of typed input ports
86  // ----------------------------------------------------------------------
87 
92 
93  PROTECTED:
94 
95  // ----------------------------------------------------------------------
96  // Handlers to implement for typed input ports
97  // ----------------------------------------------------------------------
98 
100  virtual void timeGetPort_handler(
101  FwIndexType portNum,
102  Fw::Time& time
103  ) = 0;
104 
105  PROTECTED:
106 
107  // ----------------------------------------------------------------------
108  // Port handler base-class functions for typed input ports
109  //
110  // Call these functions directly to bypass the corresponding ports
111  // ----------------------------------------------------------------------
112 
115  FwIndexType portNum,
116  Fw::Time& time
117  );
118 
119  PRIVATE:
120 
121  // ----------------------------------------------------------------------
122  // Calls for messages received on typed input ports
123  // ----------------------------------------------------------------------
124 
126  static void m_p_timeGetPort_in(
127  Fw::PassiveComponentBase* callComp,
128  FwIndexType portNum,
129  Fw::Time& time
130  );
131 
132  PRIVATE:
133 
134  // ----------------------------------------------------------------------
135  // Typed input ports
136  // ----------------------------------------------------------------------
137 
139  Fw::InputTimePort m_timeGetPort_InputPort[NUM_TIMEGETPORT_INPUT_PORTS];
140 
141  };
142 
143 }
144 
145 #endif
I32 FwEnumStoreType
Definition: FpConfig.h:64
PlatformIndexType FwIndexType
Definition: FpConfig.h:25
C++-compatible configuration header for fprime configuration.
void init()
Object initializer.
Definition: ObjBase.cpp:27
Definition: Time.hpp:9
Auto-generated base for PosixTime component.
virtual void timeGetPort_handler(FwIndexType portNum, Fw::Time &time)=0
Handler for input port timeGetPort.
Fw::InputTimePort * get_timeGetPort_InputPort(FwIndexType portNum)
void timeGetPort_handlerBase(FwIndexType portNum, Fw::Time &time)
Handler base-class function for input port timeGetPort.
friend class PosixTimeComponentBaseFriend
Friend class for white-box testing.
virtual ~PosixTimeComponentBase()
Destroy PosixTimeComponentBase object.
FwIndexType getNum_timeGetPort_InputPorts() const
PosixTimeComponentBase(const char *compName="")
Construct PosixTimeComponentBase object.