Public Member Functions | Private Member Functions | Private Attributes | List of all members
RTT::marsh::PropertyMarshaller Class Reference

#include <PropertyMarshaller.hpp>

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

Public Member Functions

virtual void flush ()
 
 PropertyMarshaller (const std::string &filename)
 
virtual void serialize (base::PropertyBase *v)
 
virtual void serialize (const PropertyBag &v)
 
 ~PropertyMarshaller ()
 
- Public Member Functions inherited from RTT::marsh::MarshallInterface
virtual ~MarshallInterface ()
 

Private Member Functions

 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 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 51 of file PropertyMarshaller.cpp.

RTT::PropertyMarshaller::~PropertyMarshaller ( )

Definition at line 62 of file PropertyMarshaller.cpp.

Member Function Documentation

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 81 of file PropertyMarshaller.cpp.

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

Serialize a property.

Parameters
vThe property to be serialized.

Implements RTT::marsh::MarshallInterface.

Definition at line 67 of file PropertyMarshaller.cpp.

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
vThe property bag to be serialized.

Implements RTT::marsh::MarshallInterface.

Definition at line 74 of file PropertyMarshaller.cpp.

Member Data Documentation

MarshallInterface* RTT::marsh::PropertyMarshaller::m
private

Definition at line 56 of file PropertyMarshaller.hpp.


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


rtt
Author(s): RTT Developers
autogenerated on Tue Jun 25 2019 19:33:45