Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
OCL::ReportingComponent Class Reference

A Component for periodically reporting Component Port contents to a human readable text format. The default format is a table with a header. More...

#include <ReportingComponent.hpp>

Inheritance diagram for OCL::ReportingComponent:
Inheritance graph
[legend]

List of all members.

Public Types

typedef
RTT::DataFlowInterface::Ports 
Ports

Public Member Functions

bool addMarshaller (RTT::marsh::MarshallInterface *headerM, RTT::marsh::MarshallInterface *bodyM)
bool removeMarshallers ()
 ReportingComponent (std::string name="Reporting")
virtual ~ReportingComponent ()
Script Methods
virtual bool configureHook ()
virtual void cleanupHook ()
virtual bool screenComponent (const std::string &comp)
bool reportComponent (const std::string &component)
bool unreportComponent (const std::string &component)
bool reportPort (const std::string &component, const std::string &port)
bool unreportPort (const std::string &component, const std::string &port)
bool reportData (const std::string &component, const std::string &dataname)
bool unreportData (const std::string &component, const std::string &datasource)
bool copydata ()
void snapshot ()
void cleanReport ()

Protected Types

typedef boost::tuple
< std::string,
RTT::base::DataSourceBase::shared_ptr,
std::string,
RTT::base::PropertyBase
*, RTT::base::InputPortInterface
*, bool, bool > 
DTupple
typedef std::vector< std::pair
< boost::shared_ptr
< RTT::marsh::MarshallInterface >
, boost::shared_ptr
< RTT::marsh::MarshallInterface > > > 
Marshallers
typedef std::vector< DTuppleReports
enum  T_Types {
  T_QualName = 0, T_PortDS, T_DataType, T_Property,
  T_Port, T_NewData, T_Tracked
}
 Use these to index DTupple objects. More...

Protected Member Functions

void makeReport2 ()
bool reportDataSource (std::string tag, std::string type, RTT::base::DataSourceBase::shared_ptr origm, RTT::base::InputPortInterface *ipi, bool)
bool screenImpl (const std::string &comp, std::ostream &output)
virtual bool startHook ()
virtual void stopHook ()
bool unreportDataSource (std::string tag)
virtual void updateHook ()

Protected Attributes

RTT::Property< std::string > config
RTT::Property< bool > decompose
RTT::Property< bool > insnapshot
Marshallers marshallers
RTT::internal::DataSource
< bool >::shared_ptr 
mchecker
 If false, a sequence size has changed.
bool onlyNewData
RTT::PropertyBag report
RTT::Property< PropertyBagreport_data
RTT::ConnPolicy report_policy
Reports root
bool snapshotted
RTT::os::TimeService::ticks starttime
RTT::Property< bool > synchronize_with_logging
RTT::Property
< RTT::os::TimeService::Seconds
timestamp
RTT::Property< bool > writeHeader

Detailed Description

A Component for periodically reporting Component Port contents to a human readable text format. The default format is a table with a header.

It can report to any data format, using the 'addMarshaller' function, which is typically done in sub classes of this component.

Configuration
The ReportingComponent is configured using its properties. For example, to enable writing a header or not. The ReportData struct describes which ports and peer components need to be monitored. You need to load properties into this struct (see RTT::Marshalling service). This struct can be filled in as such:
     <?xml version="1.0" encoding="UTF-8"?>
     <!DOCTYPE properties SYSTEM "cpf.dtd">
     <properties>
        <!-- ... other component properties .. -->

        <struct name="ReportData" type="PropertyBag">
           <!-- Monitor all ports of a Component : -->
           <simple name="Component" type="string"><description></description><value>ComponentX</value></simple>

           <!-- Monitor a single Data or base::Buffer-Port of another Component : -->
           <simple name="Port" type="string"><description></description><value>ComponentY.PortZ</value></simple>
           <!-- add as many lines as desired... -->
        </struct>
     </properties>

Definition at line 81 of file ReportingComponent.hpp.


Member Typedef Documentation

tuple that describes each sample. Uses get<N>() to read it: @0 The qualified name of the data (componentname.portname) @1 The data source of the data. Always returns the last value. @2 A copy command to copy from this data source to another one @3 The target data source for the copy operation @4 The type of the data, "Data" (props and attrs) or "Port". @5 'newdata': The new data flag. Flags if the DataSource contains new data. @6 'tracked': True if this source may lead to additional data. If false, the source in itself will not cause to a re-scan. Used in copydata() to allow ports to be rescanned, while props and attrs never cause this (they always have newdata, but this is ignored).

Definition at line 204 of file ReportingComponent.hpp.

typedef std::vector< std::pair<boost::shared_ptr<RTT::marsh::MarshallInterface>, boost::shared_ptr<RTT::marsh::MarshallInterface> > > OCL::ReportingComponent::Marshallers [protected]

Definition at line 229 of file ReportingComponent.hpp.

Definition at line 91 of file ReportingComponent.hpp.

typedef std::vector<DTupple> OCL::ReportingComponent::Reports [protected]

Stores the 'datasource' of all reported items as properties.

Definition at line 211 of file ReportingComponent.hpp.


Member Enumeration Documentation

Use these to index DTupple objects.

Enumerator:
T_QualName 
T_PortDS 
T_DataType 
T_Property 
T_Port 
T_NewData 
T_Tracked 

Definition at line 207 of file ReportingComponent.hpp.


Constructor & Destructor Documentation

OCL::ReportingComponent::ReportingComponent ( std::string  name = "Reporting")

Set up a component for reporting.

Definition at line 177 of file ReportingComponent.cpp.

Definition at line 213 of file ReportingComponent.cpp.


Member Function Documentation

Adds a Plugin to receive incomming data. The marshallers become owned by this component.

Parameters:
headerA marshaller which writes out a header when this component is started. May be null (0).
bodyA marshaller wich will get periodically a serialisation request to process incomming data. May be null(0).

example: addMarshaller( new HeaderMarshaller(), new ContentsMarshaller() );

Definition at line 216 of file ReportingComponent.cpp.

Definition at line 640 of file ReportingComponent.cpp.

Implementation of base::TaskCore::cleanupHook(). Calls store() and clears the reporting configuration.

Reimplemented from RTT::base::TaskCore.

Definition at line 237 of file ReportingComponent.cpp.

Implementation of base::TaskCore::configureHook(). Calls load().

Reimplemented from RTT::base::TaskCore.

Reimplemented in OCL::TcpReporting.

Definition at line 243 of file ReportingComponent.cpp.

This real-time function makes copies of the data to be reported.

Returns:
true if new data is available.

Definition at line 594 of file ReportingComponent.cpp.

Definition at line 608 of file ReportingComponent.cpp.

Remove and delete all added Marshallers.

Definition at line 231 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::reportComponent ( const std::string &  component)

Report all the data ports of a component.

Definition at line 344 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::reportData ( const std::string &  component,
const std::string &  dataname 
)

Report a specific data source of a component.

Definition at line 470 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::reportDataSource ( std::string  tag,
std::string  type,
RTT::base::DataSourceBase::shared_ptr  origm,
RTT::base::InputPortInterface ipi,
bool  track 
) [protected]

Definition at line 506 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::reportPort ( const std::string &  component,
const std::string &  port 
)

Report a specific data port of a component.

Definition at line 382 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::screenComponent ( const std::string &  comp) [virtual]

Write state information of a component. This method must be overridden by a subclass to be useful.

Reimplemented in OCL::FileReporting, and OCL::ConsoleReporting.

Definition at line 301 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::screenImpl ( const std::string &  comp,
std::ostream &  output 
) [protected]

This method writes out the status of a component's interface.

Definition at line 308 of file ReportingComponent.cpp.

Copy the reported data and trigger the generation of a sampling line.

Definition at line 586 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::startHook ( ) [protected, virtual]

Reimplemented from RTT::base::TaskCore.

Reimplemented in OCL::TcpReporting, OCL::NetcdfReporting, OCL::FileReporting, and OCL::ConsoleReporting.

Definition at line 538 of file ReportingComponent.cpp.

void OCL::ReportingComponent::stopHook ( ) [protected, virtual]

Reimplemented from RTT::base::TaskCore.

Reimplemented in OCL::TcpReporting, OCL::NetcdfReporting, OCL::FileReporting, and OCL::ConsoleReporting.

Definition at line 684 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::unreportComponent ( const std::string &  component)

Unreport the data ports of a component.

Definition at line 364 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::unreportData ( const std::string &  component,
const std::string &  datasource 
)

Unreport a specific data source of a component.

Definition at line 502 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::unreportDataSource ( std::string  tag) [protected]

Definition at line 527 of file ReportingComponent.cpp.

bool OCL::ReportingComponent::unreportPort ( const std::string &  component,
const std::string &  port 
)

Unreport a specific data port of a component.

Definition at line 459 of file ReportingComponent.cpp.

void OCL::ReportingComponent::updateHook ( ) [protected, virtual]

This not real-time function processes the copied data.

Reimplemented from RTT::base::TaskCore.

Definition at line 646 of file ReportingComponent.cpp.


Member Data Documentation

Definition at line 238 of file ReportingComponent.hpp.

Definition at line 240 of file ReportingComponent.hpp.

Definition at line 241 of file ReportingComponent.hpp.

Definition at line 230 of file ReportingComponent.hpp.

If false, a sequence size has changed.

Definition at line 250 of file ReportingComponent.hpp.

Definition at line 245 of file ReportingComponent.hpp.

Definition at line 231 of file ReportingComponent.hpp.

Definition at line 243 of file ReportingComponent.hpp.

Definition at line 244 of file ReportingComponent.hpp.

Definition at line 212 of file ReportingComponent.hpp.

Used to communicate between snapshot() and updateHook() if updateHook needs to make a copy.

Definition at line 237 of file ReportingComponent.hpp.

Definition at line 247 of file ReportingComponent.hpp.

Definition at line 242 of file ReportingComponent.hpp.

Definition at line 248 of file ReportingComponent.hpp.

Definition at line 239 of file ReportingComponent.hpp.


The documentation for this class was generated from the following files:


ocl
Author(s): OCL Development Team
autogenerated on Thu Jan 2 2014 11:38:08