F´ Flight Software - C/C++ Documentation  devel
A framework for building embedded system applications to NASA flight quality standards.
LinuxTimerComponentAc.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title LinuxTimerComponentAc.hpp
3 // \author Generated by fpp-to-cpp
4 // \brief hpp file for LinuxTimer component base class
5 // ======================================================================
6 
7 #ifndef Svc_LinuxTimerComponentAc_HPP
8 #define Svc_LinuxTimerComponentAc_HPP
9 
10 #include "FpConfig.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  // Connect typed input ports to typed output ports
59  // ----------------------------------------------------------------------
60 
63  FwIndexType portNum,
64  Svc::InputCyclePort* port
65  );
66 
67 #if FW_PORT_SERIALIZATION
68 
69  public:
70 
71  // ----------------------------------------------------------------------
72  // Connect serial input ports to typed output ports
73  // ----------------------------------------------------------------------
74 
77  FwIndexType portNum,
78  Fw::InputSerializePort* port
79  );
80 
81 #endif
82 
83  PROTECTED:
84 
85  // ----------------------------------------------------------------------
86  // Component construction and destruction
87  // ----------------------------------------------------------------------
88 
91  const char* compName = ""
92  );
93 
95  virtual ~LinuxTimerComponentBase();
96 
97  PROTECTED:
98 
99  // ----------------------------------------------------------------------
100  // Getters for numbers of typed output ports
101  // ----------------------------------------------------------------------
102 
107 
108  PROTECTED:
109 
110  // ----------------------------------------------------------------------
111  // Connection status queries for typed output ports
112  // ----------------------------------------------------------------------
113 
118  FwIndexType portNum
119  );
120 
121  PROTECTED:
122 
123  // ----------------------------------------------------------------------
124  // Invocation functions for typed output ports
125  // ----------------------------------------------------------------------
126 
128  void CycleOut_out(
129  FwIndexType portNum,
130  Svc::TimerVal& cycleStart
131  );
132 
133  PRIVATE:
134 
135  // ----------------------------------------------------------------------
136  // Typed output ports
137  // ----------------------------------------------------------------------
138 
140  Svc::OutputCyclePort m_CycleOut_OutputPort[NUM_CYCLEOUT_OUTPUT_PORTS];
141 
142  };
143 
144 }
145 
146 #endif
I32 FwEnumStoreType
Definition: FpConfig.h:51
PlatformIndexType FwIndexType
Definition: FpConfig.h:20
C++-compatible configuration header for fprime configuration.
void init()
Object initializer.
Definition: ObjBase.cpp:27
Auto-generated base for LinuxTimer component.
void CycleOut_out(FwIndexType portNum, Svc::TimerVal &cycleStart)
Invoke output port CycleOut.
FwIndexType getNum_CycleOut_OutputPorts() const
void set_CycleOut_OutputPort(FwIndexType portNum, Svc::InputCyclePort *port)
Connect port to CycleOut[portNum].
friend class LinuxTimerComponentBaseFriend
Friend class for white-box testing.
bool isConnected_CycleOut_OutputPort(FwIndexType portNum)
virtual ~LinuxTimerComponentBase()
Destroy LinuxTimerComponentBase object.
LinuxTimerComponentBase(const char *compName="")
Construct LinuxTimerComponentBase object.
Serializable class for carrying timer values.
Definition: TimerVal.hpp:22