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

Detailed Description

Configuration reader class.

Definition at line 30 of file reader.h.

#include <reader.h>

Inheritance diagram for ariles::ns_yaml_cpp03::Reader:
ariles::ns_yaml_cpp03::Base< ariles::read::Visitor, impl::Reader > ariles::read::Visitor ariles::serialization::Base ariles::visitor::Base< ariles::ConfigurableFlags > ariles::visitor::Visitor

Public Types

enum  SizeLimitEnforcementType {
  SIZE_LIMIT_UNDEFINED = 0, SIZE_LIMIT_NONE = 1, SIZE_LIMIT_EQUAL = 2, SIZE_LIMIT_RANGE = 3,
  SIZE_LIMIT_MIN = 4
}
 
typedef ariles::ConfigurableFlags Parameters
 

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)
 Descend to the entry with the given name. More...
 
void ascend ()
 Ascend from the current entry to its parent. More...
 
bool getMapEntryNames (std::vector< std::string > &child_names)
 
std::size_t startArray ()
 
void shiftArray ()
 
void endArray ()
 
const serialization::Features & getSerializationFeatures () const
 
template<int t_size_limit_type>
std::size_t startMap (const std::size_t &min=0, const std::size_t &max=0)
 
virtual void endMap ()
 
virtual bool startRoot (const std::string &name)
 
virtual void endRoot (const std::string &name)
 
template<class t_Entry >
ARILES_BASIC_TYPES_LIST void start (t_Entry &entry, const std::string &name, const Parameters &parameters)
 
template<class t_Entry >
bool operator() (t_Entry &entry, const std::string &name, const Parameters &parameters)
 
template<class t_Ariles >
const Parameters & getParameters (const t_Ariles &ariles_class) const
 

Static Public Member Functions

static void openFile (std::ifstream &config_ifs, const std::string &file_name)
 open configuration file More...
 

Protected Types

typedef impl::Reader Impl
 
typedef ARILES_SHARED_PTR< impl::Reader > ImplPtr
 

Protected Member Functions

std::size_t getMapSize (const bool)
 
template<int t_size_limit_type>
std::size_t checkSize (const std::size_t &, const std::size_t &=0, const std::size_t &=0) const
 
virtual std::size_t startMapImpl (const std::size_t size)
 
const ariles::ConfigurableFlags & getDefaultParameters () const
 

Protected Attributes

ImplPtr impl_
 

Member Typedef Documentation

◆ Impl

typedef impl::Reader ariles::ns_yaml_cpp03::Base< ariles::read::Visitor , impl::Reader >::Impl
protectedinherited

Definition at line 31 of file yaml_cpp03.h.

◆ ImplPtr

typedef ARILES_SHARED_PTR<impl::Reader > ariles::ns_yaml_cpp03::Base< ariles::read::Visitor , impl::Reader >::ImplPtr
protectedinherited

Definition at line 32 of file yaml_cpp03.h.

◆ Parameters

typedef ariles::ConfigurableFlags ariles::serialization::Base::Parameters
inherited

Definition at line 62 of file serialization.h.

Member Enumeration Documentation

◆ SizeLimitEnforcementType

enum ariles::read::Visitor::SizeLimitEnforcementType
inherited
Enumerator
SIZE_LIMIT_UNDEFINED 
SIZE_LIMIT_NONE 
SIZE_LIMIT_EQUAL 
SIZE_LIMIT_RANGE 
SIZE_LIMIT_MIN 

Definition at line 34 of file read.h.

Constructor & Destructor Documentation

◆ Reader() [1/2]

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

Constructor.

Parameters
[in]file_name

Definition at line 74 of file reader.cpp.

◆ Reader() [2/2]

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

Constructor.

Parameters
[in]input_stream

Definition at line 86 of file reader.cpp.

Member Function Documentation

◆ ascend()

void ariles::ns_yaml_cpp03::Reader::ascend ( )
virtual

Ascend from the current entry to its parent.

Implements ariles::read::Visitor.

Definition at line 120 of file reader.cpp.

◆ checkSize()

template<int t_size_limit_type>
std::size_t ariles::read::Visitor::checkSize ( const std::size_t &  ,
const std::size_t &  = 0,
const std::size_t &  = 0 
) const
inlineprotectedinherited

Definition at line 46 of file read.h.

◆ descend()

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

Descend to the entry with the given name.

Parameters
[in]child_namechild node name
Returns
true if successful.

Reimplemented from ariles::read::Visitor.

Definition at line 103 of file reader.cpp.

◆ endArray()

void ariles::ns_yaml_cpp03::Reader::endArray ( )
virtual

Implements ariles::read::Visitor.

Definition at line 167 of file reader.cpp.

◆ endMap()

virtual void ariles::read::Visitor::endMap ( )
inlinevirtualinherited

Reimplemented in ariles::ns_msgpack_compact::Reader.

Definition at line 128 of file read.h.

◆ endRoot()

virtual void ariles::read::Visitor::endRoot ( const std::string &  name)
inlinevirtualinherited

Reimplemented in ariles::ns_msgpack::Reader, and ariles::ns_pugixml::Reader.

Definition at line 148 of file read.h.

◆ getDefaultParameters()

const ariles::ConfigurableFlags & ariles::visitor::Base< ariles::ConfigurableFlags >::getDefaultParameters ( ) const
inlineprotectedinherited

Definition at line 33 of file common.h.

◆ getMapEntryNames()

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

Reimplemented from ariles::read::Visitor.

Definition at line 126 of file reader.cpp.

◆ getMapSize()

std::size_t ariles::ns_yaml_cpp03::Reader::getMapSize ( const bool  )
protectedvirtual

Implements ariles::read::Visitor.

Definition at line 96 of file reader.cpp.

◆ getParameters()

template<class t_Ariles >
const Parameters& ariles::serialization::Base::getParameters ( const t_Ariles &  ariles_class) const
inlineinherited

Definition at line 68 of file serialization.h.

◆ getSerializationFeatures()

const serialization::Features& ariles::ns_yaml_cpp03::Base< ariles::read::Visitor , impl::Reader >::getSerializationFeatures ( ) const
inlinevirtualinherited

Implements ariles::serialization::Base.

Definition at line 48 of file yaml_cpp03.h.

◆ openFile()

static void ariles::read::Visitor::openFile ( std::ifstream &  config_ifs,
const std::string &  file_name 
)
inlinestaticinherited

open configuration file

Parameters
[out]config_ifs
[in]file_name

Definition at line 81 of file read.h.

◆ operator()()

template<class t_Entry >
bool ariles::read::Visitor::operator() ( t_Entry &  entry,
const std::string &  name,
const Parameters &  parameters 
)
inlineinherited

Definition at line 200 of file read.h.

◆ shiftArray()

void ariles::ns_yaml_cpp03::Reader::shiftArray ( )
virtual

Implements ariles::read::Visitor.

Definition at line 157 of file reader.cpp.

◆ start()

template<class t_Entry >
ARILES_BASIC_TYPES_LIST void ariles::read::Visitor::start ( t_Entry &  entry,
const std::string &  name,
const Parameters &  parameters 
)
inlineinherited

Definition at line 166 of file read.h.

◆ startArray()

std::size_t ariles::ns_yaml_cpp03::Reader::startArray ( )
virtual

Implements ariles::read::Visitor.

Definition at line 148 of file reader.cpp.

◆ startMap()

template<int t_size_limit_type>
std::size_t ariles::read::Visitor::startMap ( const std::size_t &  min = 0,
const std::size_t &  max = 0 
)
inlineinherited

Definition at line 117 of file read.h.

◆ startMapImpl()

virtual std::size_t ariles::read::Visitor::startMapImpl ( const std::size_t  size)
inlineprotectedvirtualinherited

Reimplemented in ariles::ns_msgpack_compact::Reader.

Definition at line 65 of file read.h.

◆ startRoot()

virtual bool ariles::read::Visitor::startRoot ( const std::string &  name)
inlinevirtualinherited

Reimplemented in ariles::ns_msgpack::Reader, and ariles::ns_pugixml::Reader.

Definition at line 137 of file read.h.

Member Data Documentation

◆ impl_

ImplPtr ariles::ns_yaml_cpp03::Base< ariles::read::Visitor , impl::Reader >::impl_
protectedinherited

Definition at line 35 of file yaml_cpp03.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.15