experimental_UserInput.3 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. .TH "experimental::UserInput" 3 "Sun Dec 27 2020" "openPilotLog" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. experimental::UserInput \- The EntryData struct\&. Contains ALL possible data\&. However depending on who is constructing it, different types are initialised\&. FUTURE: Would it be necessary to able to change data? George: I would say no because we dont want to fuck around with the entry\&. Collect data from user -> Pack it up in the entry -> Consume it\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <UserInput\&.h>\fP
  11. .SS "Public Types"
  12. .in +1c
  13. .ti -1c
  14. .RI "enum \fBMetaTag\fP { \fBPilot\fP, \fBFlight\fP, \fBAircraft\fP }"
  15. .br
  16. .in -1c
  17. .SS "Public Member Functions"
  18. .in +1c
  19. .ti -1c
  20. .RI "\fBUserInput\fP (EntryData new_data, MetaTag tag)"
  21. .br
  22. .ti -1c
  23. .RI "QString \fBonly\fP (QString data_type) const"
  24. .br
  25. .ti -1c
  26. .RI "const EntryData & \fBall\fP () const"
  27. .br
  28. .in -1c
  29. .SS "Public Attributes"
  30. .in +1c
  31. .ti -1c
  32. .RI "enum experimental::UserInput::MetaTag \fBmeta_tag\fP"
  33. .br
  34. .in -1c
  35. .SH "Detailed Description"
  36. .PP
  37. The EntryData struct\&. Contains ALL possible data\&. However depending on who is constructing it, different types are initialised\&. FUTURE: Would it be necessary to able to change data? George: I would say no because we dont want to fuck around with the entry\&. Collect data from user -> Pack it up in the entry -> Consume it\&.
  38. .PP
  39. \fBTodo\fP
  40. .RS 4
  41. Figure out exactly what the database would prefer as return value George: I would assume key: value pairs where the keys are what you would put in the queries\&. This will affect data aswell (and propably simplify it)
  42. .RE
  43. .PP
  44. .SH "Author"
  45. .PP
  46. Generated automatically by Doxygen for openPilotLog from the source code\&.