RTT::marsh::PropertyMarshaller Class Reference

#include <PropertyMarshaller.hpp>

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

List of all members.

Public Member Functions

virtual void flush ()
virtual void flush ()
 PropertyMarshaller (const std::string &filename)
 PropertyMarshaller (const std::string &filename)
virtual void serialize (const PropertyBag &v)
virtual void serialize (base::PropertyBase *v)
virtual void serialize (const PropertyBag &v)
virtual void serialize (base::PropertyBase *v)
 ~PropertyMarshaller ()
 ~PropertyMarshaller ()

Private Member Functions

 PropertyMarshaller (const PropertyMarshaller &)
 PropertyMarshaller (const PropertyMarshaller &)

Private Attributes

MarshallInterfacem

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 53 of file install/include/rtt/marsh/PropertyMarshaller.hpp.


Constructor & Destructor Documentation

RTT::marsh::PropertyMarshaller::PropertyMarshaller ( const PropertyMarshaller  )  [private]
RTT::PropertyMarshaller::PropertyMarshaller ( const std::string &  filename  ) 

Construct a PropertyMarshaller which writes to a file.

Parameters:
filename 

Definition at line 42 of file PropertyMarshaller.cpp.

RTT::PropertyMarshaller::~PropertyMarshaller (  ) 

Definition at line 53 of file PropertyMarshaller.cpp.

RTT::marsh::PropertyMarshaller::PropertyMarshaller ( const PropertyMarshaller  )  [private]
RTT::marsh::PropertyMarshaller::PropertyMarshaller ( const std::string &  filename  ) 

Construct a PropertyMarshaller which writes to a file.

Parameters:
filename 
RTT::marsh::PropertyMarshaller::~PropertyMarshaller (  ) 

Member Function Documentation

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

Implements RTT::marsh::MarshallInterface.

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

Implements RTT::marsh::MarshallInterface.

Definition at line 72 of file PropertyMarshaller.cpp.

virtual void RTT::marsh::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::marsh::MarshallInterface.

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

Serialize a property.

Parameters:
v The property to be serialized.

Implements RTT::marsh::MarshallInterface.

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::marsh::MarshallInterface.

Definition at line 65 of file PropertyMarshaller.cpp.

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

Serialize a property.

Parameters:
v The property to be serialized.

Implements RTT::marsh::MarshallInterface.

Definition at line 58 of file PropertyMarshaller.cpp.


Member Data Documentation


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