PropertyMarshaller Class Reference

#include </home/sspr/src/www/orocos-1.0/export/build/orocos-rtt-1.2.2/build/rtt/marsh/PropertyMarshaller.hpp>

Inheritance diagram for PropertyMarshaller:

Marshaller List of all members.

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.


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.


Constructor & Destructor Documentation

PropertyMarshaller ( const std::string &  filename  ) 

Construct a PropertyMarshaller which writes to a file.

Parameters:
filename 


Member Function Documentation

virtual void serialize ( PropertyBase v  )  [virtual]

Serialize a property.

Parameters:
v The property to be serialized.

Implements Marshaller.

virtual void 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 Marshaller.

virtual void 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 Marshaller.


The documentation for this class was generated from the following file:
Generated on Fri Oct 19 16:27:24 2007 for Orocos by  doxygen 1.5.1