Marshaller Class Reference
[Property Interface]

#include <rtt/Marshaller.hpp>

Inheritance diagram for Marshaller:

List of all members.

---

Detailed Description

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

See also:

Demarshaller

Property

PropertyBag

Definition at line 57 of file Marshaller.hpp.

Public Member Functions
virtual	~Marshaller ()
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.

---

Member Function Documentation

virtual void serialize

(

PropertyBase *

v

)

[pure virtual]

Serialize a property.

Parameters:

v

The property to be serialized.

Implemented in CPFMarshaller< std::ostream >, EmptyHeaderMarshaller, EmptyMarshaller, Orocos1Marshaller, PropertyMarshaller, SimpleMarshaller, TableHeaderMarshaller, TableMarshaller, and XMLMarshaller.

Referenced by PropertyMarshaller::serialize().

virtual void 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 CPFMarshaller< std::ostream >, EmptyHeaderMarshaller, EmptyMarshaller, INIMarshaller, Orocos1Marshaller, PropertyMarshaller, SimpleMarshaller, TableHeaderMarshaller, TableMarshaller, XMLMarshaller, and XMLRPCMarshaller.

virtual void 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 CPFMarshaller< std::ostream >, EmptyHeaderMarshaller, EmptyMarshaller, INIMarshaller, Orocos1Marshaller, PropertyMarshaller, SimpleMarshaller, TableHeaderMarshaller, TableMarshaller, XMLMarshaller, and XMLRPCMarshaller.

Referenced by PropertyMarshaller::flush().

---

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

• rtt/Marshaller.hpp

---