branoholy / regilo Goto Github PK

More instructions at one line are not correctly shown in the coverage results.

The line below is marked as tested even if the method is never called.

if(obj != nullptr) obj->method();

A split to more lines should correct it.

if(obj != nullptr)
    obj->method();

It is necessary to

• change the beautifier settings,
• reformat the source code,
• check new coverage results.

• Setup OCLint/clang-tidy
• Setup Travis for OCLint/clang-tidy
• Create custom rules for all beautifier parameters

Add the close() method to the Log classes to close the file before destructor.

Test everything to get 100% coverage.

• ScanRecord & ScanData
• Log & TimedLog
• SerialController
• SocketController
• HokuyoController
• NeatoController

CMake option() should be used only for bool variables. Use set instead

set(<variable> <value> [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE])

Two changes are necessary

• The argument -c should take the device:protocol format where protocol could be log. Then, the -e argument could also point to a log path. The argument -l would be used only for the output log.
• The argument -l is missing in the regilo-scan example.

All controller classes should inherit from IController. INeatoController and IHokuyoController miss the inheritance.

• Add a separate class for the metadata

• Improve backward compatibility of the log classes

• Read metadata and determinate the version/class in runtime

• Other improvements

• Use the following format

  # comment
  type <string>
  version <int>
  [additional metadata]
  
  <name:char/string> [<length:int> ]<value:any>
  <name:char/string> [<length:int> ]<value:any>
  
  <name:char/string> [<length:int> ]<value:any>
  <name:char/string> [<length:int> ]<value:any>
  ...
  

  Example for regilo::Log

  # Log
  type log
  version 2
  
  c 11 testmode on
  r 0
  
  c 7 gettime
  r 12 Sunday 16:45
  

  Example for regilo::TimedLog

  # TimedLog
  # Backward compatible with class log
  type timedlog
  version 2
  timeres 1 1000
  
  c 11 testmode on
  r 0
  t 1718373
  
  c 7 gettime
  r 12 Sunday 16:45
  t 18373748