Ariles
Public Member Functions | Protected Types | Protected Attributes | List of all members
ariles::ns_yaml_cpp03::Writer Class Reference

Detailed Description

Configuration writer class.

Definition at line 30 of file writer.h.

#include <writer.h>

Inheritance diagram for ariles::ns_yaml_cpp03::Writer:
ariles::ns_yaml_cpp03::Base< t_Base, t_Implementation > t_Base

Public Member Functions

 Writer (const std::string &file_name)
 
 Writer (std::ostream &output_stream)
 
void descend (const std::string &map_name)
 Starts a nested map in the configuration file. More...
 
void startMap (const std::size_t)
 
void endMap ()
 
void flush ()
 
void startArray (const std::size_t, const bool compact=false)
 
void endArray ()
 
void startRoot (const std::string &name)
 
void endRoot (const std::string &name)
 
const serialization::FeaturesgetSerializationFeatures () const
 

Protected Types

typedef t_Implementation Impl
 
typedef ARILES_SHARED_PTR< t_Implementation > ImplPtr
 

Protected Attributes

ImplPtr impl_
 

Member Typedef Documentation

◆ Impl

template<class t_Base, class t_Implementation>
typedef t_Implementation ariles::ns_yaml_cpp03::Base< t_Base, t_Implementation >::Impl
protectedinherited

Definition at line 31 of file yaml_cpp03.h.

◆ ImplPtr

template<class t_Base, class t_Implementation>
typedef ARILES_SHARED_PTR<t_Implementation> ariles::ns_yaml_cpp03::Base< t_Base, t_Implementation >::ImplPtr
protectedinherited

Definition at line 32 of file yaml_cpp03.h.

Constructor & Destructor Documentation

◆ Writer() [1/2]

ariles::ns_yaml_cpp03::Writer::Writer ( const std::string &  file_name)
explicit

Definition at line 101 of file writer.cpp.

◆ Writer() [2/2]

ariles::ns_yaml_cpp03::Writer::Writer ( std::ostream &  output_stream)
explicit

Definition at line 107 of file writer.cpp.

Member Function Documentation

◆ descend()

void ariles::ns_yaml_cpp03::Writer::descend ( const std::string &  map_name)

Starts a nested map in the configuration file.

Parameters
[in]map_namename of the map

Definition at line 114 of file writer.cpp.

◆ endArray()

void ariles::ns_yaml_cpp03::Writer::endArray ( )

Definition at line 159 of file writer.cpp.

◆ endMap()

void ariles::ns_yaml_cpp03::Writer::endMap ( )

Definition at line 131 of file writer.cpp.

◆ endRoot()

void ariles::ns_yaml_cpp03::Writer::endRoot ( const std::string &  name)

Definition at line 178 of file writer.cpp.

◆ flush()

void ariles::ns_yaml_cpp03::Writer::flush ( )

Definition at line 143 of file writer.cpp.

◆ getSerializationFeatures()

template<class t_Base, class t_Implementation>
const serialization::Features& ariles::ns_yaml_cpp03::Base< t_Base, t_Implementation >::getSerializationFeatures ( ) const
inlineinherited

Definition at line 48 of file yaml_cpp03.h.

◆ startArray()

void ariles::ns_yaml_cpp03::Writer::startArray ( const std::size_t  ,
const bool  compact = false 
)

Definition at line 150 of file writer.cpp.

◆ startMap()

void ariles::ns_yaml_cpp03::Writer::startMap ( const std::size_t  )

Definition at line 121 of file writer.cpp.

◆ startRoot()

void ariles::ns_yaml_cpp03::Writer::startRoot ( const std::string &  name)

Definition at line 165 of file writer.cpp.

Member Data Documentation

◆ impl_

template<class t_Base, class t_Implementation>
ImplPtr ariles::ns_yaml_cpp03::Base< t_Base, t_Implementation >::impl_
protectedinherited

Definition at line 35 of file yaml_cpp03.h.


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