F´ Flight Software - C/C++ Documentation NASA-v1.6.0
A framework for building embedded system applications to NASA flight quality standards.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Example.hpp
Go to the documentation of this file.
1// ======================================================================
2// \title Example.hpp
3// \author T. Chieu
4// \brief hpp file for Example component implementation class
5// ======================================================================
6
7#ifndef Example_HPP
8#define Example_HPP
9
10#include "FppTest/port/ExampleComponentAc.hpp"
11
12
13 class Example :
14 public ExampleComponentBase
15 {
16
17 public:
18
19 // ----------------------------------------------------------------------
20 // Construction, initialization, and destruction
21 // ----------------------------------------------------------------------
22
25 Example(
26 const char *const compName
27 );
28
31 void init(
32 const NATIVE_INT_TYPE instance = 0
33 );
34
37 ~Example();
38
39 PRIVATE:
40
41 // ----------------------------------------------------------------------
42 // Handler implementations for user-defined typed input ports
43 // ----------------------------------------------------------------------
44
47 void arrayArgsIn_handler(
48 const NATIVE_INT_TYPE portNum,
49 const PortArray &a,
52 PortArray &aRef
55 );
56
59 PortArray arrayReturnIn_handler(
60 const NATIVE_INT_TYPE portNum,
61 const PortArray &a,
64 PortArray &aRef
67 );
68
71 void enumArgsIn_handler(
72 const NATIVE_INT_TYPE portNum,
73 const PortEnum &e,
76 PortEnum &eRef
79 );
80
83 PortEnum enumReturnIn_handler(
84 const NATIVE_INT_TYPE portNum,
85 const PortEnum &e,
88 PortEnum &eRef
91 );
92
95 void noArgsIn_handler(
96 const NATIVE_INT_TYPE portNum
97 );
98
101 bool noArgsReturnIn_handler(
102 const NATIVE_INT_TYPE portNum
103 );
104
107 void primitiveArgsIn_handler(
108 const NATIVE_INT_TYPE portNum,
109 U32 u32,
110 U32 &u32Ref,
111 F32 f32,
112 F32 &f32Ref,
113 bool b,
114 bool &bRef
115 );
116
119 U32 primitiveReturnIn_handler(
120 const NATIVE_INT_TYPE portNum,
121 U32 u32,
122 U32 &u32Ref,
123 F32 f32,
124 F32 &f32Ref,
125 bool b,
126 bool &bRef
127 );
128
131 void stringArgsIn_handler(
132 const NATIVE_INT_TYPE portNum,
133 const str80String &str80,
136 str80RefString &str80Ref,
137 const str100String &str100,
140 str100RefString &str100Ref
141 );
142
145 void structArgsIn_handler(
146 const NATIVE_INT_TYPE portNum,
147 const PortStruct &s,
150 PortStruct &sRef
153 );
154
157 PortStruct structReturnIn_handler(
158 const NATIVE_INT_TYPE portNum,
159 const PortStruct &s,
162 PortStruct &sRef
165 );
166
167 PRIVATE:
168
169 // ----------------------------------------------------------------------
170 // Handler implementations for user-defined serial input ports
171 // ----------------------------------------------------------------------
172
175 void serialIn_handler(
176 NATIVE_INT_TYPE portNum,
178 );
179
180 public:
181
184
185 };
186
187
188#endif
PlatformIntType NATIVE_INT_TYPE
Definition BasicTypes.h:51
float F32
32-bit floating point
Definition BasicTypes.h:45
Fw::SerializeStatus serializeStatus
Enables checking the serialization status of serial port invocations.
Definition Example.hpp:183
void init(const NATIVE_INT_TYPE instance=0)
Definition Example.cpp:25
~Example()
Definition Example.cpp:33
SerializeStatus
forward declaration for string