experimental_AEntry.3 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. .TH "experimental::AEntry" 3 "Sat Dec 26 2020" "openPilotLog" \" -*- nroff -*-
  2. .ad l
  3. .nh
  4. .SH NAME
  5. experimental::AEntry \- The Entry class encapsulates table metadata(table name, row id) and data for new and existing entries in the database to operate on\&.
  6. .SH SYNOPSIS
  7. .br
  8. .PP
  9. .PP
  10. \fC#include <aentry\&.h>\fP
  11. .PP
  12. Inherited by \fBexperimental::AAircraftEntry\fP, \fBexperimental::AFlightEntry\fP, \fBexperimental::APilotEntry\fP, and \fBexperimental::ATailEntry\fP\&.
  13. .SS "Public Member Functions"
  14. .in +1c
  15. .ti -1c
  16. .RI "\fBAEntry\fP (const \fBAEntry\fP &)=default"
  17. .br
  18. .ti -1c
  19. .RI "\fBAEntry\fP & \fBoperator=\fP (const \fBAEntry\fP &)=default"
  20. .br
  21. .ti -1c
  22. .RI "\fBAEntry\fP (\fBDataPosition\fP position_)"
  23. .br
  24. .ti -1c
  25. .RI "\fBAEntry\fP (TableData table_data)"
  26. .br
  27. .ti -1c
  28. .RI "\fBAEntry\fP (\fBDataPosition\fP position_, TableData table_data)"
  29. .br
  30. .ti -1c
  31. .RI "void \fBsetData\fP (TableData table_data)"
  32. .br
  33. .ti -1c
  34. .RI "void \fBsetPosition\fP (\fBDataPosition\fP position_)"
  35. .br
  36. .ti -1c
  37. .RI "const \fBDataPosition\fP & \fBgetPosition\fP ()"
  38. .br
  39. .ti -1c
  40. .RI "const TableData & \fBgetData\fP ()"
  41. .br
  42. .in -1c
  43. .SS "Public Attributes"
  44. .in +1c
  45. .ti -1c
  46. .RI "TableData \fBtableData\fP"
  47. .br
  48. .in -1c
  49. .SS "Protected Attributes"
  50. .in +1c
  51. .ti -1c
  52. .RI "\fBDataPosition\fP \fBposition\fP"
  53. .br
  54. .in -1c
  55. .SH "Detailed Description"
  56. .PP
  57. The Entry class encapsulates table metadata(table name, row id) and data for new and existing entries in the database to operate on\&.
  58. [G]: Define what data is public and what not\&. For objects such as \fBDataPosition\fP which are consumable its no biggy\&. Are entries the same? If so we could avoid getters and setters [F]: In the way we are using the entries atm, we do access and edit the TableData quite frequently\&. Maybe the data could be public, but the position private? Except for creating a new entry, the position should never really be changed\&.
  59. .SH "Author"
  60. .PP
  61. Generated automatically by Doxygen for openPilotLog from the source code\&.