Detailed Description

Configuration reader class.

Definition at line 26 of file writer.h.

#include <writer.h>

Inheritance diagram for ariles::ns_yaml_cpp::Writer:

Public Types
typedef ariles::ConfigurableFlags	Parameters

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)
	Starts a nested map in the configuration file. More...

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

void	flush ()
	Flush the configuration to the output. More...

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::Features &	getSerializationFeatures () const

virtual void	ascend ()

virtual void	shiftArray ()

virtual void	startMatrix (const bool compact=false)

virtual void	startMatrixRow ()

virtual void	endMatrixRow ()

virtual void	endMatrix ()

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

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

Protected Types
typedef impl::Writer	Impl

typedef ARILES_SHARED_PTR< impl::Writer >	ImplPtr

Protected Member Functions
const ariles::ConfigurableFlags &	getDefaultParameters () const

Protected Attributes
ImplPtr	impl_

Member Typedef Documentation

◆ Impl

typedef impl::Writer ariles::ns_yaml_cpp::Base< ariles::write::Visitor , impl::Writer >::Impl

protectedinherited

Definition at line 27 of file yaml_cpp.h.

◆ ImplPtr

typedef ARILES_SHARED_PTR<impl::Writer > ariles::ns_yaml_cpp::Base< ariles::write::Visitor , impl::Writer >::ImplPtr

protectedinherited

Definition at line 28 of file yaml_cpp.h.

◆ Parameters

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

inherited

Definition at line 62 of file serialization.h.

Constructor & Destructor Documentation

◆ Writer() [1/2]

ariles::ns_yaml_cpp::Writer::Writer ( const std::string & file_name )

explicit

Definition at line 98 of file writer.cpp.

◆ Writer() [2/2]

ariles::ns_yaml_cpp::Writer::Writer ( std::ostream & output_stream )

explicit

Definition at line 104 of file writer.cpp.

Member Function Documentation

◆ ascend()

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

inlinevirtualinherited

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

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

virtual

Starts a nested map in the configuration file.

Parameters

[in] map_name name of the map

Reimplemented from ariles::write::Visitor.

Definition at line 111 of file writer.cpp.

◆ endArray()

void ariles::ns_yaml_cpp::Writer::endArray ( )

virtual

Reimplemented from ariles::write::Visitor.

Definition at line 162 of file writer.cpp.

◆ endMap()

void ariles::ns_yaml_cpp::Writer::endMap ( )

virtual

Ends a nested map in the configuration file.

Reimplemented from ariles::write::Visitor.

Definition at line 131 of file writer.cpp.

◆ endMatrix()

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

inlinevirtualinherited

Reimplemented in ariles::ns_octave::Writer.

Definition at line 99 of file write.h.

◆ endMatrixRow()

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

inlinevirtualinherited

Reimplemented in ariles::ns_octave::Writer.

Definition at line 96 of file write.h.

◆ endRoot()

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

virtual

Reimplemented from ariles::write::Visitor.

Definition at line 183 of file writer.cpp.

◆ flush()

void ariles::ns_yaml_cpp::Writer::flush ( )

virtual

Flush the configuration to the output.

Implements ariles::write::Visitor.

Definition at line 143 of file writer.cpp.

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

const serialization::Features& ariles::ns_yaml_cpp::Base< ariles::write::Visitor , impl::Writer >::getSerializationFeatures ( ) const

inlinevirtualinherited

Implements ariles::serialization::Base.

Definition at line 44 of file yaml_cpp.h.

◆ openFile()

static void ariles::write::Visitor::openFile	(	std::ofstream &	config_ofs,
		const std::string &	file_name
	)

inlinestaticinherited

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
	)

inlineinherited

Definition at line 141 of file write.h.

◆ shiftArray()

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

inlinevirtualinherited

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
	)

inlineinherited

Definition at line 130 of file write.h.

◆ startArray()

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

virtual

Implements ariles::write::Visitor.

Definition at line 151 of file writer.cpp.

◆ startMap()

void ariles::ns_yaml_cpp::Writer::startMap ( const std::size_t num_entries )

virtual

Starts a nested map in the configuration file.

Parameters

[in] num_entries number of child entries

Reimplemented from ariles::write::Visitor.

Definition at line 120 of file writer.cpp.

◆ startMatrix()

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

inlinevirtualinherited

Reimplemented in ariles::ns_octave::Writer.

Definition at line 89 of file write.h.

◆ startMatrixRow()

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

inlinevirtualinherited

Reimplemented in ariles::ns_octave::Writer.

Definition at line 93 of file write.h.

◆ startRoot()

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

virtual

Reimplemented from ariles::write::Visitor.

Definition at line 169 of file writer.cpp.

Member Data Documentation

◆ impl_

ImplPtr ariles::ns_yaml_cpp::Base< ariles::write::Visitor , impl::Writer >::impl_

protectedinherited

Definition at line 31 of file yaml_cpp.h.

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

extra_visitors/yaml_cpp/ariles/visitors/yaml_cpp/writer.h
extra_visitors/yaml_cpp/src/writer.cpp

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ Impl

◆ ImplPtr

◆ Parameters

Constructor & Destructor Documentation

◆ Writer() [1/2]

◆ Writer() [2/2]

Member Function Documentation

◆ ascend()

◆ descend()

◆ endArray()

◆ endMap()

◆ endMatrix()

◆ endMatrixRow()

◆ endRoot()

◆ flush()

◆ getDefaultParameters()

◆ getParameters()

◆ getSerializationFeatures()

◆ openFile()

◆ operator()()

◆ shiftArray()

◆ start()

◆ startArray()

◆ startMap()

◆ startMatrix()

◆ startMatrixRow()

◆ startRoot()

Member Data Documentation

◆ impl_