RTT::Marshaller Class Reference
[Property Interface]
A Marshaller converts Property objects to a (file/text) format. More...
#include <rtt/Marshaller.hpp>
Public Member Functions | |
| virtual void | serialize (PropertyBase *v)=0 |
| Serialize a property. | |
| virtual void | serialize (const PropertyBag &v)=0 |
| Serialize the contents of a property bag with headers and footers. | |
| virtual void | flush ()=0 |
| Flush all buffers, write footers. | |
Detailed Description
A Marshaller converts Property objects to a (file/text) format.
- See also:
- Demarshaller
- Property
- PropertyBag
Definition at line 58 of file Marshaller.hpp.
Member Function Documentation
| virtual void RTT::Marshaller::flush | ( | ) | [pure virtual] |
Flush all buffers, write footers.
Instructs the Marshaller to flush any remaining buffered data and write a footer to indicate that serialization is done. A marshaller may choose to write nothing until this function is called, or print a summary, or anything else.
Implemented in RTT::CPFMarshaller< std::ostream >, RTT::EmptyHeaderMarshaller< o_stream >, RTT::EmptyMarshaller, RTT::INIMarshaller< output_stream >, RTT::Orocos1Marshaller< output_stream >, RTT::PropertyMarshaller, RTT::SimpleMarshaller< o_stream >, RTT::TableHeaderMarshaller< o_stream >, RTT::TableMarshaller< o_stream >, RTT::XMLMarshaller< o_stream >, and RTT::XMLRPCMarshaller< output_stream >.
| virtual void RTT::Marshaller::serialize | ( | const PropertyBag & | v | ) | [pure virtual] |
Serialize the contents of a property bag with headers and footers.
Use this method on your 'root' PropertyBag, such that headers and footers are written.
- Parameters:
-
v The property bag to be serialized.
Implemented in RTT::CPFMarshaller< std::ostream >, RTT::EmptyHeaderMarshaller< o_stream >, RTT::EmptyMarshaller, RTT::INIMarshaller< output_stream >, RTT::Orocos1Marshaller< output_stream >, RTT::PropertyMarshaller, RTT::SimpleMarshaller< o_stream >, RTT::TableHeaderMarshaller< o_stream >, RTT::TableMarshaller< o_stream >, RTT::XMLMarshaller< o_stream >, and RTT::XMLRPCMarshaller< output_stream >.
| virtual void RTT::Marshaller::serialize | ( | PropertyBase * | v | ) | [pure virtual] |
Serialize a property.
- Parameters:
-
v The property to be serialized.
Implemented in RTT::CPFMarshaller< std::ostream >, RTT::EmptyHeaderMarshaller< o_stream >, RTT::EmptyMarshaller, RTT::Orocos1Marshaller< output_stream >, RTT::PropertyMarshaller, RTT::SimpleMarshaller< o_stream >, RTT::TableHeaderMarshaller< o_stream >, RTT::TableMarshaller< o_stream >, and RTT::XMLMarshaller< o_stream >.
The documentation for this class was generated from the following file:
- rtt/Marshaller.hpp
