[Bug 626] New: Simplify ReporterComponent configuration

Submitted by sspr on Tue, 2009-03-03 10:05

For more infomation about this bug, visit <https://www.fmtc.be/bugzilla/orocos/show_bug.cgi?id=626>
Summary: Simplify ReporterComponent configuration
Product: OCL
Version: unspecified
Platform: AMD 64bit
OS/Version: All
Status: NEW
Severity: minor
Priority: P3
Component: Reporting
AssignedTo: orocos-dev [..] ...
ReportedBy: peter [dot] soetens [..] ...
CC: orocos-dev [..] ...
Estimated Hours: 0.0

The confusion of a user on how to configure the ReportingComponent inspired me
to an improvement. Today, the property file of the ReportingComponent looks
like:

<properties>
  <simple name="AutoTrigger" type="boolean"><description>When set to 1, the 
data is taken upon each update(), otherwise, the data is only taken when the 
user invokes 'snapshot()'.\
</description><value>1</value></simple>
  <simple name="Configuration" type="string"><description>The name of the 
property file which lists what is to be 
reported.</description><value>deployment/logging/log-plant.cpf</v\
alue></simple>
  <simple name="WriteHeader" type="boolean"><description>Set to true to start 
each report with a header.</description><value>1</value></simple>
  <simple name="Decompose" type="boolean"><description>Set to true to 
decompose data ports.</description><value>1</value></simple>
  <simple name="ReportFile" type="string"><description>Location on disc to 
store the reports.</description><value>port-log.dat</value></simple>
</properties>

Note that the 'Configuration' property points to another file, which lists
which
ports and/or components to report. This makes that in practice, in order to
configure the ReportingComponent, three XML files are needed: the application
deployment file, the Reporter's property file and the 'Configuration' file. We
could, using the 'LoadProperties' scheme, allow to put the contents of
Configuration in the standard property file and let the ReportingComponent scan
the loaded properties in order to know which ports to log:

<properties>
  <simple name="AutoTrigger" type="boolean"><description>When set to 1, the 
data is taken upon each update(), otherwise, the data is only taken when the 
user invokes 'snapshot()'.\
</description><value>1</value></simple>
  <simple name="WriteHeader" type="boolean"><description>Set to true to start 
each report with a header.</description><value>1</value></simple>
  <simple name="Decompose" type="boolean"><description>Set to true to 
decompose data ports.</description><value>1</value></simple>
  <simple name="ReportFile" type="string"><description>Location on disc to 
store the reports.</description><value>port-log.dat</value></simple>
  <struct name="ReportData" type="PropertyBag">
    <simple name="Component" 
type="string"><description></description><value>Plant</value></simple>
    <simple name="Port" 
type="string"><description></description><value>Automatic.output</value></simple>
  </struct>
</properties>

The struct 'ReportData' has been added and Configuration becomes obsolete (we
can keep it for backwards compatibility).

‹ providing RTT or OCL with type vector<ANYTYPE> [Bug 637] New: Deployer locks computer under Xenomai, if fails to cleanly configure/start components ›
»

[Bug 626] Simplify ReporterComponent configuration

Submitted by sspr on Mon, 2009-03-23 08:50.

For more infomation about this bug, visit https://www.fmtc.be/bugzilla/orocos/show_bug.cgi?id=626

Peter Soetens <peter [dot] soetens [..] ...> changed:

What |Removed |Added
----------------------------------------------------------------------------
Resolution| |FIXED
Status|ASSIGNED |RESOLVED

--- Comment #2 from Peter Soetens <peter [dot] soetens [..] ...> 2009-03-23 09:48:19 ---
Closing this bug as fix is released.

»

[Bug 626] Simplify ReporterComponent configuration

Submitted by sspr on Tue, 2009-03-03 10:05.

For more infomation about this bug, visit <https://www.fmtc.be/bugzilla/orocos/show_bug.cgi?id=626>

Peter Soetens <peter [dot] soetens [..] ...> changed:

What |Removed |Added
----------------------------------------------------------------------------
Target Milestone|--- |1.8.0
Status|NEW |ASSIGNED

--- Comment #1 from Peter Soetens <peter [dot] soetens [..] ...> 2009-03-03 11:03:32 ---
I still had to submit this one. In case you encounter problems in OCL 1.8.x,
you could attach them here as well. The backwards compatibility has been
dropped, see the updated Reporting manual and the Changes document for RTT
1.8.0.

»