walk::YamlWriter< T > Class Template Reference

Write a YAML file to serialize a pattern generator computed trajectories. More...

#include <yaml.hh>

List of all members.

Public Types
typedef T	patternGenerator_t
	Pattern generator type.
Public Member Functions
void	write (std::ostream &stream) const
	Write the YAML data into an output stream.
void	write (boost::filesystem::path &filename) const
	Write the YAML data on the disk.
void	write (const std::string &filename) const
	Write the YAML data on the disk.
Constructor and destructor.
	YamlWriter (const patternGenerator_t &pg)
	Default constructor.
	~YamlWriter ()
	Destructor.
Private Attributes
const patternGenerator_t &	patternGenerator_
	Reference to the underlying pattern generator.

---

Detailed Description

template<typename T>
class walk::YamlWriter< T >

Write a YAML file to serialize a pattern generator computed trajectories.

This class takes a pattern generator as its input. The pattern generator is passed when instantiating the class. Then, using the write method, one can write a file on the filesystem of fill an output stream.

The underlying pattern generator is kept as a constant reference. Therefore the pattern generator object life-time must exceed the YamlWriter instance life-time.

Template Parameters:

T

Pattern generator type.

Definition at line 192 of file yaml.hh.

---

Member Typedef Documentation

template<typename T>

typedef T walk::YamlWriter< T >::patternGenerator_t

Pattern generator type.

Definition at line 196 of file yaml.hh.

---

Constructor & Destructor Documentation

template<typename T>

walk::YamlWriter< T >::YamlWriter

(

const patternGenerator_t &

pg

)

[explicit]

Default constructor.

Parameters:

pg

Pattern generator which trajectories will be serialized.

template<typename T>

walk::YamlWriter< T >::~YamlWriter

(

)

Destructor.

---

Member Function Documentation

template<typename T>

void walk::YamlWriter< T >::write

(

std::ostream &

stream

)

const

Write the YAML data into an output stream.

Parameters:

stream

Output stream into which the YAML data will be written.

template<typename T>

void walk::YamlWriter< T >::write

(

boost::filesystem::path &

filename

)

const

Write the YAML data on the disk.

Parameters:

filename

Filename on the filesystem.

template<typename T>

void walk::YamlWriter< T >::write

(

const std::string &

filename

)

const

Write the YAML data on the disk.

Parameters:

filename

Filename on the filesystem.

---

Member Data Documentation

template<typename T>

const patternGenerator_t& walk::YamlWriter< T >::patternGenerator_ [private]

Reference to the underlying pattern generator.

Definition at line 229 of file yaml.hh.

---

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

• yaml.hh