Detailed Description

Definition at line 19 of file write.h.

#include <write.h>

Inheritance diagram for ariles::write::Visitor:

Public Types
typedef ariles::ConfigurableFlags	Parameters

Public Member Functions
virtual void	flush ()=0
	Flush the configuration to the output. More...

virtual void	descend (const std::string &map_name)
	Starts a nested map in the configuration file. More...

virtual void	ascend ()

virtual void	startMap (const std::size_t num_entries)
	Starts a nested map in the configuration file. More...

virtual void	endMap ()
	Ends a nested map in the configuration file. More...

virtual void	startArray (const std::size_t size, const bool compact=false)=0

virtual void	shiftArray ()

virtual void	endArray ()

virtual void	startMatrix (const bool compact=false)

virtual void	startMatrixRow ()

virtual void	endMatrixRow ()

virtual void	endMatrix ()

virtual void	startRoot (const std::string &name)

virtual void	endRoot (const std::string &name)

template<typename t_Entry >
ARILES_BASIC_TYPES_LIST void	start (const t_Entry &entry, const std::string &entry_name, const Parameters &param)

template<typename t_Entry >
void	operator() (const t_Entry &entry, const std::string &entry_name, const Parameters &param)

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::ofstream &config_ofs, const std::string &file_name)
	open configuration file More...

Protected Member Functions
	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.

Constructor & Destructor Documentation

◆ Visitor()

ariles::write::Visitor::Visitor ( )

inlineprotected

Definition at line 22 of file write.h.

◆ ~Visitor()

ariles::write::Visitor::~Visitor ( )

inlineprotected

Definition at line 23 of file write.h.

Member Function Documentation

◆ ascend()

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

inlinevirtual

Reimplemented in ariles::ns_array::GenericWriter< t_NameValuePair >, ariles::ns_octave::Writer, ariles::ns_pugixml::Writer, and ariles::ns_ros::Writer.

Definition at line 58 of file write.h.

◆ descend()

virtual void ariles::write::Visitor::descend ( const std::string & map_name )

inlinevirtual

Starts a nested map in the configuration file.

Parameters

[in] map_name name of the map

Reimplemented in ariles::ns_array::GenericWriter< t_NameValuePair >, ariles::ns_octave::Writer, ariles::ns_msgpack::Writer, ariles::ns_pugixml::Writer, ariles::ns_ros::Writer, and ariles::ns_yaml_cpp::Writer.

Definition at line 54 of file write.h.

◆ endArray()

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

inlinevirtual

Reimplemented in ariles::ns_array::GenericWriter< t_NameValuePair >, ariles::ns_octave::Writer, ariles::ns_pugixml::Writer, ariles::ns_yaml_cpp::Writer, and ariles::ns_ros::Writer.

Definition at line 85 of file write.h.

◆ endMap()

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

inlinevirtual

Ends a nested map in the configuration file.

Reimplemented in ariles::ns_array::GenericWriter< t_NameValuePair >, ariles::ns_octave::Writer, and ariles::ns_yaml_cpp::Writer.

Definition at line 76 of file write.h.

◆ endMatrix()

virtual void ariles::write::Visitor::endMatrix ( )

inlinevirtual

Reimplemented in ariles::ns_octave::Writer.

Definition at line 99 of file write.h.

◆ endMatrixRow()

virtual void ariles::write::Visitor::endMatrixRow ( )

inlinevirtual

Reimplemented in ariles::ns_octave::Writer.

Definition at line 96 of file write.h.

◆ endRoot()

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

inlinevirtual

Reimplemented in ariles::ns_msgpack::Writer, ariles::ns_pugixml::Writer, ariles::ns_ros::Writer, and ariles::ns_yaml_cpp::Writer.

Definition at line 112 of file write.h.

◆ flush()

virtual void ariles::write::Visitor::flush ( )

pure virtual

Flush the configuration to the output.

Implemented in ariles::ns_array::GenericWriter< t_NameValuePair >, ariles::ns_msgpack::Writer, ariles::ns_msgpack_compact::Writer, ariles::ns_octave::Writer, ariles::ns_yaml_cpp::Writer, ariles::ns_ros::Writer, and ariles::ns_pugixml::Writer.

◆ getDefaultParameters()

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

inlineprotectedinherited

Definition at line 33 of file common.h.

◆ 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::write::Visitor::openFile	(	std::ofstream &	config_ofs,
		const std::string &	file_name
	)

inlinestatic

open configuration file

Parameters

[out]	config_ofs
[in]	file_name

Definition at line 33 of file write.h.

◆ operator()()

template<typename t_Entry >

void ariles::write::Visitor::operator()	(	const t_Entry &	entry,
		const std::string &	entry_name,
		const Parameters &	param
	)

inline

Definition at line 141 of file write.h.

◆ shiftArray()

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

inlinevirtual

Reimplemented in ariles::ns_array::GenericWriter< t_NameValuePair >, ariles::ns_octave::Writer, ariles::ns_pugixml::Writer, and ariles::ns_ros::Writer.

Definition at line 82 of file write.h.

◆ start()

template<typename t_Entry >

ARILES_BASIC_TYPES_LIST void ariles::write::Visitor::start	(	const t_Entry &	entry,
		const std::string &	entry_name,
		const Parameters &	param
	)

inline

Definition at line 130 of file write.h.

◆ startArray()

virtual void ariles::write::Visitor::startArray	(	const std::size_t	size,
		const bool	compact = `false`
	)

pure virtual

Implemented in ariles::ns_array::GenericWriter< t_NameValuePair >, ariles::ns_octave::Writer, ariles::ns_msgpack::Writer, ariles::ns_msgpack_compact::Writer, ariles::ns_pugixml::Writer, ariles::ns_yaml_cpp::Writer, and ariles::ns_ros::Writer.

◆ startMap()

virtual void ariles::write::Visitor::startMap ( const std::size_t num_entries )

inlinevirtual

Starts a nested map in the configuration file.

Parameters

[in] num_entries number of child entries

Reimplemented in ariles::ns_array::GenericWriter< t_NameValuePair >, ariles::ns_octave::Writer, ariles::ns_msgpack::Writer, ariles::ns_msgpack_compact::Writer, and ariles::ns_yaml_cpp::Writer.

Definition at line 68 of file write.h.

◆ startMatrix()

virtual void ariles::write::Visitor::startMatrix ( const bool compact = false )

inlinevirtual

Reimplemented in ariles::ns_octave::Writer.

Definition at line 89 of file write.h.

◆ startMatrixRow()

virtual void ariles::write::Visitor::startMatrixRow ( )

inlinevirtual

Reimplemented in ariles::ns_octave::Writer.

Definition at line 93 of file write.h.

◆ startRoot()

virtual void ariles::write::Visitor::startRoot ( const std::string & name )

inlinevirtual

Reimplemented in ariles::ns_msgpack::Writer, ariles::ns_pugixml::Writer, ariles::ns_ros::Writer, and ariles::ns_yaml_cpp::Writer.

Definition at line 104 of file write.h.

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

include/ariles/visitors/write.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Typedef Documentation

◆ Parameters

Constructor & Destructor Documentation

◆ Visitor()

◆ ~Visitor()

Member Function Documentation

◆ ascend()

◆ descend()

◆ endArray()

◆ endMap()

◆ endMatrix()

◆ endMatrixRow()

◆ endRoot()

◆ flush()

◆ getDefaultParameters()

◆ getParameters()

◆ getSerializationFeatures()

◆ openFile()

◆ operator()()

◆ shiftArray()

◆ start()

◆ startArray()

◆ startMap()

◆ startMatrix()

◆ startMatrixRow()

◆ startRoot()