RTT::TableHeaderMarshaller< o_stream > Class Template Reference

A Marshaller for generating headers of tables. More...

#include <rtt/marsh/TableHeaderMarshaller.hpp>

Inheritance diagram for RTT::TableHeaderMarshaller< o_stream >:

List of all members.

Public Types
typedef o_stream	output_stream
typedef o_stream	OutputStream
Public Member Functions
	TableHeaderMarshaller (output_stream &os)
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.
int	store (const std::string &s)
virtual void	serialize (const Property< PropertyBag > &v)
virtual void	flush ()
	Flush all buffers, write footers.
void	setStream (o_stream &_s)
	Set a new Stream.
o_stream &	getStream ()
	Get the current Stream.
Protected Attributes
o_stream *	s

---

Detailed Description

template<typename o_stream>
class RTT::TableHeaderMarshaller< o_stream >

A Marshaller for generating headers of tables.

It is used in conjunction with TableMarshaller and generates a header for the following numbers.

Todo:

: build a tree for formatting and print all on flush().

Definition at line 55 of file TableHeaderMarshaller.hpp.

---

Member Function Documentation

template<typename o_stream >

virtual void RTT::TableHeaderMarshaller< o_stream >::flush

(

)

[inline, 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.

Definition at line 173 of file TableHeaderMarshaller.hpp.

o_stream & RTT::StreamProcessor< o_stream >::getStream

(

)

[inline, inherited]

Get the current Stream.

Returns:

The current Stream.

Definition at line 81 of file StreamProcessor.hpp.

template<typename o_stream >

virtual void RTT::TableHeaderMarshaller< o_stream >::serialize

(

const Property< PropertyBag > &

v

)

[inline, virtual]

Serializing a propery<bag> : pad the line below with spaces.

Print our name

Serialize all properties on the line below.

Pad this line with spaces

Definition at line 131 of file TableHeaderMarshaller.hpp.

References RTT::Property< T >::get(), RTT::PropertyBase::getName(), RTT::TableHeaderMarshaller< o_stream >::serialize(), and RTT::TableHeaderMarshaller< o_stream >::store().

template<typename o_stream >

virtual void RTT::TableHeaderMarshaller< o_stream >::serialize

(

const PropertyBag &

v

)

[inline, 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.

Definition at line 84 of file TableHeaderMarshaller.hpp.

References RTT::PropertyBag::getProperties(), and RTT::TableHeaderMarshaller< o_stream >::serialize().

template<typename o_stream >

virtual void RTT::TableHeaderMarshaller< o_stream >::serialize

(

PropertyBase *

v

)

[inline, virtual]

Serialize a property.

Parameters:

v

The property to be serialized.

Implements RTT::Marshaller.

Definition at line 74 of file TableHeaderMarshaller.hpp.

References RTT::PropertyBase::getName(), and RTT::TableHeaderMarshaller< o_stream >::store().

Referenced by RTT::TableHeaderMarshaller< o_stream >::serialize().

void RTT::StreamProcessor< o_stream >::setStream

(

o_stream &

_s

)

[inline, inherited]

Set a new Stream.

Parameters:

_s

The stream to be processed.

Definition at line 72 of file StreamProcessor.hpp.

template<typename o_stream >

int RTT::TableHeaderMarshaller< o_stream >::store

(

const std::string &

s

)

[inline]

Returns:

the number of characters on this line.

Definition at line 119 of file TableHeaderMarshaller.hpp.

Referenced by RTT::TableHeaderMarshaller< o_stream >::serialize().

---

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

• rtt/marsh/TableHeaderMarshaller.hpp