ariles::read::Visitor Class Reference

Detailed Description

Definition at line 31 of file read.h.

#include <read.h>

Inheritance diagram for ariles::read::Visitor:

Classes
struct	RelaxedSizeLimitType

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
virtual bool	descend (const std::string &child_name)
	Descend to the entry with the given name. More...
virtual void	ascend ()=0
	Ascend from the current entry to its parent. More...
template<int t_size_limit_type>
std::size_t	startMap (const std::size_t &min=0, const std::size_t &max=0)
virtual bool	getMapEntryNames (std::vector< std::string > &)
virtual void	endMap ()
virtual std::size_t	startArray ()=0
virtual void	shiftArray ()=0
virtual void	endArray ()=0
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
virtual const Features &	getSerializationFeatures () const =0

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

Protected Member Functions
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	getMapSize (const bool expect_empty)=0
virtual std::size_t	startMapImpl (const std::size_t size)
	Visitor ()
	~Visitor ()
const ariles::ConfigurableFlags &	getDefaultParameters () const

Member Typedef Documentation

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

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

Visitor()

ariles::read::Visitor::Visitor ( )

inlineprotected

Definition at line 70 of file read.h.

~Visitor()

ariles::read::Visitor::~Visitor ( )

inlineprotected

Definition at line 71 of file read.h.

Member Function Documentation

ascend()

virtual void ariles::read::Visitor::ascend ( )

pure virtual

Ascend from the current entry to its parent.

Implemented in ariles::ns_msgpack_compact::Reader, ariles::ns_yaml_cpp03::Reader, ariles::ns_msgpack::Reader, and ariles::ns_pugixml::Reader.

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

inlineprotected

Definition at line 46 of file read.h.

descend()

virtual bool ariles::read::Visitor::descend ( const std::string &  child_name )

inlinevirtual

Descend to the entry with the given name.

Parameters

[in]

child_name

child node name

Returns

true if successful.

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

Definition at line 102 of file read.h.

endArray()

virtual void ariles::read::Visitor::endArray ( )

pure virtual

Implemented in ariles::ns_yaml_cpp03::Reader, ariles::ns_msgpack_compact::Reader, ariles::ns_pugixml::Reader, and ariles::ns_msgpack::Reader.

endMap()

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

inlinevirtual

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 )

inlinevirtual

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()

virtual bool ariles::read::Visitor::getMapEntryNames ( std::vector< std::string > &  )

inlinevirtual

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

Definition at line 123 of file read.h.

getMapSize()

virtual std::size_t ariles::read::Visitor::getMapSize ( const bool  expect_empty )

protectedpure virtual

Implemented in ariles::ns_msgpack_compact::Reader, ariles::ns_yaml_cpp03::Reader, ariles::ns_msgpack::Reader, and ariles::ns_pugixml::Reader.

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()

virtual const Features& ariles::serialization::Base::getSerializationFeatures ( ) const

pure virtualinherited

Implemented in ariles::ns_array::GenericWriter< t_NameValuePair >, ariles::ns_rapidjson::Base< ariles::read::Visitor, impl::Reader >, ariles::ns_rapidjson::Base< ariles::write::Visitor, impl::Writer >, ariles::ns_yaml_cpp03::Base< ariles::read::Visitor, impl::Reader >, ariles::ns_yaml_cpp03::Base< ariles::write::Visitor, impl::Writer >, ariles::ns_msgpack::Base< ariles::read::Visitor, impl::Reader >, ariles::ns_msgpack::Base< ariles::write::Visitor, impl::Writer >, ariles::ns_pugixml::Base< ariles::read::Visitor, impl::Reader >, ariles::ns_pugixml::Base< ariles::write::Visitor, impl::Writer >, ariles::ns_ros::Base< ariles::read::Visitor, impl::Reader >, ariles::ns_ros::Base< ariles::write::Visitor, impl::Writer >, ariles::ns_octave::Writer, ariles::ns_yaml_cpp::Base< ariles::read::Visitor, impl::Reader >, and ariles::ns_yaml_cpp::Base< ariles::write::Visitor, impl::Writer >.

openFile()

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

inlinestatic

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  )

inline

Definition at line 200 of file read.h.

shiftArray()

virtual void ariles::read::Visitor::shiftArray ( )

pure virtual

Implemented in ariles::ns_msgpack_compact::Reader, ariles::ns_yaml_cpp03::Reader, ariles::ns_msgpack::Reader, and ariles::ns_pugixml::Reader.

start()

template<class t_Entry >

ARILES_BASIC_TYPES_LIST void ariles::read::Visitor::start ( t_Entry &  entry, const std::string &  name, const Parameters &  parameters  )

inline

Definition at line 166 of file read.h.

startArray()

virtual std::size_t ariles::read::Visitor::startArray ( )

pure virtual

Implemented in ariles::ns_msgpack_compact::Reader, ariles::ns_yaml_cpp03::Reader, ariles::ns_pugixml::Reader, and ariles::ns_msgpack::Reader.

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  )

inline

Definition at line 117 of file read.h.

startMapImpl()

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

inlineprotectedvirtual

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 )

inlinevirtual

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

Definition at line 137 of file read.h.

---

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

• include/ariles/visitors/read.h