XMLMarshaller Class Template Reference

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

Inheritance diagram for XMLMarshaller:

List of all members.

---

Detailed Description

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

Marshalls a PropertyBag to a non standard XML format.

Warning:

: No Orocos class exists yet which can read the XML data back in.

Public Types
typedef o_stream	output_stream
typedef o_stream	OutputStream
Public Member Functions
	XMLMarshaller (output_stream &os)
virtual void	flush ()
	Flush all buffers, write footers.
virtual void	serialize (PropertyBase *p)
	Serialize a property.
virtual void	serialize (const PropertyBag &v)
	Serialize the contents of a property bag with headers and footers.
void	setStream (o_stream &_s)
	Set a new Stream.
o_stream &	getStream ()
	Get the current Stream.
Protected Member Functions
virtual void	introspect (PropertyBase *pb)
	Callback for a Property which is not a PropertyBag.
virtual void	introspect (Property< bool > &v)
	introspect a property of type bool.
virtual void	introspect (Property< char > &v)
	introspect a property of type char.
virtual void	introspect (Property< int > &v)
	introspect a property of type int.
virtual void	introspect (Property< unsigned int > &v)
	introspect a property of type unsigned int.
virtual void	introspect (Property< double > &v)
	introspect a property of type double.
virtual void	introspect (Property< std::string > &v)
	introspect a property of type string.
virtual void	introspect (Property< PropertyBag > &v)
	Callback for a Property which is a PropertyBag.
virtual void	introspect (const PropertyBag &v, std::string name)
template<class T>
void	introspect (Property< T > &v)
	Unknown types must decompose theirselves into the primitives.
void	introspect_T (PropertyBase *t)
	The default handler to execute when an unknown type is being decomposed.
Protected Attributes
o_stream *	s

---

Member Function Documentation

virtual void introspect

(

Property< bool > &

v

)

[inline, protected, virtual]

introspect a property of type bool.

Parameters:

v

The property to be introspectd.

Implements PropertyIntrospection.

virtual void introspect

(

Property< char > &

v

)

[inline, protected, virtual]

introspect a property of type char.

Parameters:

v

The property to be introspectd.

Implements PropertyIntrospection.

virtual void introspect

(

Property< int > &

v

)

[inline, protected, virtual]

introspect a property of type int.

Parameters:

v

The property to be introspectd.

Implements PropertyIntrospection.

virtual void introspect

(

Property< unsigned int > &

v

)

[inline, protected, virtual]

introspect a property of type unsigned int.

Parameters:

v

The property to be introspectd.

Implements PropertyIntrospection.

virtual void introspect

(

Property< double > &

v

)

[inline, protected, virtual]

introspect a property of type double.

Parameters:

v

The property to be introspectd.

Implements PropertyIntrospection.

virtual void introspect

(

Property< std::string > &

v

)

[inline, protected, virtual]

introspect a property of type string.

Parameters:

v

The property to be introspectd.

Implements PropertyIntrospection.

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

virtual void serialize

(

PropertyBase *

p

)

[inline, virtual]

Serialize a property.

Parameters:

v

The property to be serialized.

Implements Marshaller.

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

void introspect

(

Property< T > &

v

)

[inherited]

Unknown types must decompose theirselves into the primitives.

See also:

TemplateTypeInfo

void setStream

(

o_stream &

_s

)

[inline, inherited]

Set a new Stream.

Parameters:

_s

The stream to be processed.

o_stream & getStream

(

)

[inline, inherited]

Get the current Stream.

Returns:

The current Stream.

---

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

• rtt/marsh/XMLMarshaller.hpp

---