RTT::PropertyMarshaller Class Reference

A class for writing a property or propertybag into file. More...

#include <rtt/marsh/PropertyMarshaller.hpp>

Inheritance diagram for RTT::PropertyMarshaller:

Public Member Functions
	PropertyMarshaller (const std::string &filename)
	Construct a PropertyMarshaller which writes to a file.
virtual void	serialize (PropertyBase *v)
	Serialize a property.
virtual void	serialize (const PropertyBag &v)
	Serialize the contents of a property bag with headers and footers.
virtual void	flush ()
	Flush all buffers, write footers.

Detailed Description

A class for writing a property or propertybag into file.

The file format used by Orocos is the 'Component Property Format'.

See also:: PropertyDemarshaller for reading the result back in.

Definition at line 52 of file PropertyMarshaller.hpp.

Constructor & Destructor Documentation

RTT::PropertyMarshaller::PropertyMarshaller ( const std::string & filename )

Construct a PropertyMarshaller which writes to a file.

Parameters:

filename

Member Function Documentation

virtual void RTT::PropertyMarshaller::flush ( ) [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.

Implements RTT::Marshaller.

virtual void RTT::PropertyMarshaller::serialize ( const PropertyBag & v ) [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.

Implements RTT::Marshaller.

virtual void RTT::PropertyMarshaller::serialize ( PropertyBase * v ) [virtual]

Serialize a property.

Parameters:

v