ConsoleReporting Class Reference
A component which writes data reports to a console. More...
#include <ConsoleReporting.hpp>
Public Types | |
|
typedef RTT::DataFlowInterface::Ports | Ports |
Public Member Functions | |
| ConsoleReporting (std::string fr_name="ReportingComponent", std::ostream &console=std::cerr) | |
| Create a reporting component which writes to a C++ stream. | |
| bool | startHook () |
| void | stopHook () |
| bool | screenComponent (const std::string &comp) |
| Writes the interface status of comp to the console. | |
| bool | addMarshaller (RTT::Marshaller *headerM, RTT::Marshaller *bodyM) |
| Adds a Plugin to receive incomming data. | |
| bool | removeMarshallers () |
| Remove and delete all added Marshallers. | |
Script Methods | |
| virtual bool | configureHook () |
| Implementation of TaskCore::configureHook(). | |
| virtual void | cleanupHook () |
| Implementation of TaskCore::cleanupHook(). | |
| bool | reportComponent (const std::string &component) |
| Report all the data ports of a component. | |
| bool | unreportComponent (const std::string &component) |
| Unreport the data ports of a component. | |
| bool | reportPort (const std::string &component, const std::string &port) |
| Report a specific data port of a component. | |
| bool | unreportPort (const std::string &component, const std::string &port) |
| Unreport a specific data port of a component. | |
| bool | reportData (const std::string &component, const std::string &dataname) |
| Report a specific data source of a component. | |
| bool | unreportData (const std::string &component, const std::string &datasource) |
| Unreport a specific data source of a component. | |
| void | snapshot () |
| This real-time function makes copies of the data to be reported. | |
| void | cleanReport () |
| Implementation of TaskCore::configureHook(). | |
Protected Types | |
|
typedef boost::tuple < std::string, RTT::DataSourceBase::shared_ptr, boost::shared_ptr < RTT::CommandInterface > , RTT::DataSourceBase::shared_ptr, std::string > | DTupple |
| typedef std::vector< DTupple > | Reports |
| Stores the 'datasource' of all reported items as properties. | |
|
typedef std::vector< std::pair < boost::shared_ptr < RTT::Marshaller > , boost::shared_ptr < RTT::Marshaller > > > | Marshallers |
Protected Member Functions | |
| bool | screenImpl (const std::string &comp, std::ostream &output) |
| This method writes out the status of a component's interface. | |
| bool | reportDataSource (std::string tag, std::string type, RTT::DataSourceBase::shared_ptr orig) |
| bool | unreportDataSource (std::string tag) |
| void | makeReport () |
| virtual void | updateHook () |
| This not real-time function processes the copied data. | |
Protected Attributes | |
| std::ostream & | mconsole |
| Console to write reports to. | |
| Reports | root |
| Marshallers | marshallers |
| RTT::PropertyBag | report |
| RTT::Property< bool > | autotrigger |
| RTT::Property< std::string > | config |
| RTT::Property< bool > | writeHeader |
| RTT::Property< bool > | decompose |
| RTT::Property< bool > | synchronize_with_logging |
| RTT::Property< PropertyBag > | report_data |
| RTT::TimeService::ticks | starttime |
|
RTT::Property < RTT::TimeService::Seconds > | timestamp |
Detailed Description
A component which writes data reports to a console.
Definition at line 14 of file ConsoleReporting.hpp.
Member Function Documentation
| bool addMarshaller | ( | RTT::Marshaller * | headerM, | |
| RTT::Marshaller * | bodyM | |||
| ) | [inherited] |
Adds a Plugin to receive incomming data.
The marshallers become owned by this component.
- Parameters:
-
header A marshaller which writes out a header when this component is started. May be null (0). body A marshaller wich will get periodically a serialisation request to process incomming data. May be null(0).
example: addMarshaller( new HeaderMarshaller(), new ContentsMarshaller() );
Referenced by ConsoleReporting::ConsoleReporting().
| void cleanReport | ( | ) | [inherited] |
Implementation of TaskCore::configureHook().
Calls load().
Definition at line 427 of file ReportingComponent.cpp.
Referenced by ReportingComponent::updateHook().
| void cleanupHook | ( | ) | [virtual, inherited] |
Implementation of TaskCore::cleanupHook().
Calls store() and clears the reporting configuration.
Definition at line 126 of file ReportingComponent.cpp.
| bool configureHook | ( | ) | [virtual, inherited] |
Implementation of TaskCore::configureHook().
Calls load().
Reimplemented in TcpReporting.
Definition at line 132 of file ReportingComponent.cpp.
References ReportingComponent::reportComponent(), ReportingComponent::reportData(), and ReportingComponent::reportPort().
The documentation for this class was generated from the following files:
