RTT::marsh::MarshallInterface Class Reference

A MarshallInterface converts Property objects to a (file/text) format. More...

#include <MarshallInterface.hpp>

Inheritance diagram for RTT::marsh::MarshallInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual void flush ()=0
virtual void flush ()=0
virtual void serialize (const PropertyBag &v)=0
virtual void serialize (base::PropertyBase *v)=0
virtual void serialize (const PropertyBag &v)=0
virtual void serialize (base::PropertyBase *v)=0
virtual ~MarshallInterface ()
virtual ~MarshallInterface ()

Detailed Description

A MarshallInterface converts Property objects to a (file/text) format.

See also:
DemarshallInterface
Property
PropertyBag

Definition at line 55 of file install/include/rtt/marsh/MarshallInterface.hpp.


Constructor & Destructor Documentation

virtual RTT::marsh::MarshallInterface::~MarshallInterface (  )  [inline, virtual]
virtual RTT::marsh::MarshallInterface::~MarshallInterface (  )  [inline, virtual]

Definition at line 58 of file rtt/marsh/MarshallInterface.hpp.


Member Function Documentation

virtual void RTT::marsh::MarshallInterface::flush (  )  [pure virtual]

Flush all buffers, write footers. Instructs the MarshallInterface 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::marsh::CPFMarshaller< std::ostream >, RTT::marsh::PropertyMarshaller, RTT::marsh::XMLRPCMarshaller< output_stream >, RTT::marsh::CPFMarshaller< std::ostream >, RTT::marsh::PropertyMarshaller, and RTT::marsh::XMLRPCMarshaller< output_stream >.

virtual void RTT::marsh::MarshallInterface::flush (  )  [pure virtual]

Flush all buffers, write footers. Instructs the MarshallInterface 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::marsh::CPFMarshaller< std::ostream >, RTT::marsh::PropertyMarshaller, RTT::marsh::XMLRPCMarshaller< output_stream >, RTT::marsh::CPFMarshaller< std::ostream >, RTT::marsh::PropertyMarshaller, and RTT::marsh::XMLRPCMarshaller< output_stream >.

virtual void RTT::marsh::MarshallInterface::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::marsh::CPFMarshaller< std::ostream >, RTT::marsh::PropertyMarshaller, RTT::marsh::XMLRPCMarshaller< output_stream >, RTT::marsh::CPFMarshaller< std::ostream >, RTT::marsh::PropertyMarshaller, and RTT::marsh::XMLRPCMarshaller< output_stream >.

virtual void RTT::marsh::MarshallInterface::serialize ( base::PropertyBase v  )  [pure virtual]

Serialize a property.

Parameters:
v The property to be serialized.

Implemented in RTT::marsh::CPFMarshaller< std::ostream >, RTT::marsh::PropertyMarshaller, RTT::marsh::CPFMarshaller< std::ostream >, and RTT::marsh::PropertyMarshaller.

virtual void RTT::marsh::MarshallInterface::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::marsh::CPFMarshaller< std::ostream >, RTT::marsh::PropertyMarshaller, RTT::marsh::XMLRPCMarshaller< output_stream >, RTT::marsh::CPFMarshaller< std::ostream >, RTT::marsh::PropertyMarshaller, and RTT::marsh::XMLRPCMarshaller< output_stream >.

virtual void RTT::marsh::MarshallInterface::serialize ( base::PropertyBase v  )  [pure virtual]

Serialize a property.

Parameters:
v The property to be serialized.

Implemented in RTT::marsh::CPFMarshaller< std::ostream >, RTT::marsh::PropertyMarshaller, RTT::marsh::CPFMarshaller< std::ostream >, and RTT::marsh::PropertyMarshaller.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


rtt
Author(s): RTT Developers
autogenerated on Fri Jan 11 09:50:07 2013