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

Detailed Description

Configuration reader class.

Definition at line 26 of file reader.h.

#include <reader.h>

Inheritance diagram for ariles::ns_yaml_cpp::Reader:
ariles::ns_yaml_cpp::Base< t_Base, t_Implementation > t_Base

Public Member Functions

 Reader (const std::string &file_name)
 Constructor. More...
 
 Reader (std::istream &input_stream)
 Constructor. More...
 
bool descend (const std::string &child_name)
 
void ascend ()
 
bool getMapEntryNames (std::vector< std::string > &child_names)
 
std::size_t startArray ()
 
void shiftArray ()
 
void endArray ()
 
const serialization::FeaturesgetSerializationFeatures () const
 

Protected Types

typedef t_Implementation Impl
 
typedef ARILES_SHARED_PTR< t_Implementation > ImplPtr
 

Protected Member Functions

std::size_t getMapSize (const bool)
 

Protected Attributes

ImplPtr impl_
 

Member Typedef Documentation

◆ Impl

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

Definition at line 27 of file yaml_cpp.h.

◆ ImplPtr

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

Definition at line 28 of file yaml_cpp.h.

Constructor & Destructor Documentation

◆ Reader() [1/2]

ariles::ns_yaml_cpp::Reader::Reader ( const std::string &  file_name)
explicit

Constructor.

Parameters
[in]file_name

Definition at line 65 of file reader.cpp.

◆ Reader() [2/2]

ariles::ns_yaml_cpp::Reader::Reader ( std::istream &  input_stream)
explicit

Constructor.

Parameters
[in]input_stream

Definition at line 72 of file reader.cpp.

Member Function Documentation

◆ ascend()

void ariles::ns_yaml_cpp::Reader::ascend ( )

Definition at line 105 of file reader.cpp.

◆ descend()

bool ariles::ns_yaml_cpp::Reader::descend ( const std::string &  child_name)

Definition at line 87 of file reader.cpp.

◆ endArray()

void ariles::ns_yaml_cpp::Reader::endArray ( )

Definition at line 158 of file reader.cpp.

◆ getMapEntryNames()

bool ariles::ns_yaml_cpp::Reader::getMapEntryNames ( std::vector< std::string > &  child_names)

Definition at line 112 of file reader.cpp.

◆ getMapSize()

std::size_t ariles::ns_yaml_cpp::Reader::getMapSize ( const bool  )
protected

Definition at line 80 of file reader.cpp.

◆ getSerializationFeatures()

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

Definition at line 44 of file yaml_cpp.h.

◆ shiftArray()

void ariles::ns_yaml_cpp::Reader::shiftArray ( )

Definition at line 147 of file reader.cpp.

◆ startArray()

std::size_t ariles::ns_yaml_cpp::Reader::startArray ( )

Definition at line 135 of file reader.cpp.

Member Data Documentation

◆ impl_

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

Definition at line 31 of file yaml_cpp.h.


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