Detailed Description

template<class t_Derived, class t_Parameters>
class ariles2::write::VisitorBase< t_Derived, t_Parameters >

Definition at line 45 of file write.h.

#include <write.h>

Inheritance diagram for ariles2::write::VisitorBase< t_Derived, t_Parameters >:

Public Types
using	ReturnType = t_ReturnType

using	Parameters = t_Parameters

Public Member Functions
virtual void	startRoot (const std::string &name, const t_Parameters &)

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

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

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

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

virtual void	endMapEntry ()

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

virtual bool	startIteratedMap (const std::size_t num_entries, const t_Parameters &param)

virtual void	startIteratedMapElement (const std::string &map_name)

virtual void	endIteratedMapElement ()

virtual void	endIteratedMap ()

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

virtual void	startArrayElement ()

virtual void	endArrayElement ()

virtual void	endArray ()

virtual void	startVector (const std::size_t size)

virtual void	startVectorElement ()

virtual void	endVectorElement ()

virtual void	endVector ()

virtual void	startMatrix (const bool dynamic, const std::size_t cols, const std::size_t rows, const t_Parameters &param)

virtual void	startMatrixRow (const std::size_t cols, const t_Parameters &param)

virtual void	startMatrixElement ()

virtual void	endMatrixElement ()

virtual void	endMatrixRow (const t_Parameters &param)

virtual void	endMatrix (const bool dynamic, const t_Parameters &param)

void	startPointer (const bool is_null, const t_Parameters &param)

void	endPointer (const bool is_null)

template<class t_Scalar >
void	writeElement (const std::complex< t_Scalar > &entry, const t_Parameters &param)

virtual void	writeElement (const std::complex< float > &entry, const t_Parameters &param)

virtual void	writeElement (const std::complex< double > &entry, const t_Parameters &param)

template<typename t_Entry >
ARILES2_BASIC_TYPES_LIST void	visit (const t_Entry &entry, const std::string &entry_name, const t_Parameters &param)

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

template<typename t_Element >
void	visitArrayElement (const t_Element &element, const t_Parameters &param)

template<typename t_Element >
void	visitVectorElement (const t_Element &element, const t_Parameters &param)

template<typename t_Element >
void	visitMatrixElement (const t_Element &element, const t_Parameters &param)

virtual const t_Parameters &	getDefaultParameters () const

template<class t_Ariles >
const t_Parameters &	getParameters (const t_Ariles &ariles_class) const

Member Typedef Documentation

◆ Parameters

template<class t_Derived , class t_Parameters , class t_ReturnType = void>

using ariles2::visitor::Base< t_Derived, t_Parameters, t_ReturnType >::Parameters = t_Parameters

inherited

Definition at line 49 of file common.h.

◆ ReturnType

template<class t_Derived , class t_Parameters , class t_ReturnType = void>

using ariles2::visitor::Base< t_Derived, t_Parameters, t_ReturnType >::ReturnType = t_ReturnType

inherited

Definition at line 48 of file common.h.

Member Function Documentation

◆ endArray()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endArray ( )

inlinevirtual

Reimplemented in ariles2::ns_yaml_cpp::Writer, ariles2::ns_rosparam::Writer, ariles2::ns_ros2param::Writer, ariles2::ns_ros2param::Declarator, ariles2::ns_rapidjson::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_octave::Writer, ariles2::ns_namevalue2::Writer, ariles2::ns_namevalue::GenericWriter< t_NameValuePair >, and ariles2::ns_graphviz::Visitor.

Definition at line 127 of file write.h.

◆ endArrayElement()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endArrayElement ( )

inlinevirtual

Reimplemented in ariles2::ns_rosparam::Writer, ariles2::ns_ros2param::Writer, ariles2::ns_ros2param::Declarator, ariles2::ns_rapidjson::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_octave::Writer, ariles2::ns_namevalue2::Writer, ariles2::ns_namevalue::GenericWriter< t_NameValuePair >, and ariles2::ns_graphviz::Visitor.

Definition at line 123 of file write.h.

◆ endIteratedMap()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endIteratedMap ( )

inlinevirtual

Definition at line 112 of file write.h.

◆ endIteratedMapElement()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endIteratedMapElement ( )

inlinevirtual

Definition at line 108 of file write.h.

◆ endMap()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endMap ( )

inlinevirtual

Ends a nested map in the configuration file.

Reimplemented in ariles2::ns_yaml_cpp::Writer, ariles2::ns_namevalue2::Writer, and ariles2::ns_namevalue::GenericWriter< t_NameValuePair >.

Definition at line 94 of file write.h.

◆ endMapEntry()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endMapEntry ( )

inlinevirtual

Reimplemented in ariles2::ns_rosparam::Writer, ariles2::ns_ros2param::Writer, ariles2::ns_ros2param::Declarator, ariles2::ns_rapidjson::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_octave::Writer, ariles2::ns_namevalue2::Writer, ariles2::ns_namevalue::GenericWriter< t_NameValuePair >, and ariles2::ns_graphviz::Visitor.

Definition at line 88 of file write.h.

◆ endMatrix()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endMatrix	(	const bool	dynamic,
		const t_Parameters &	param
	)

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer.

Definition at line 214 of file write.h.

◆ endMatrixElement()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endMatrixElement ( )

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer.

Definition at line 200 of file write.h.

◆ endMatrixRow()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endMatrixRow ( const t_Parameters & param )

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer.

Definition at line 205 of file write.h.

◆ endPointer()

template<class t_Derived , class t_Parameters >

void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endPointer ( const bool is_null )

inline

Definition at line 253 of file write.h.

◆ endRoot()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endRoot ( const std::string & name )

inlinevirtual

Reimplemented in ariles2::ns_yaml_cpp::Writer, ariles2::ns_rosparam::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_msgpack::Writer, and ariles2::ns_graphviz::Visitor.

Definition at line 56 of file write.h.

◆ endVector()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endVector ( )

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer.

Definition at line 148 of file write.h.

◆ endVectorElement()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::endVectorElement ( )

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer.

Definition at line 143 of file write.h.

◆ flush()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::flush ( )

pure virtual

Flush the configuration to the output.

Implemented in ariles2::ns_yaml_cpp::Writer, ariles2::ns_rosparam::Writer, ariles2::ns_ros2param::Writer, ariles2::ns_ros2param::Declarator, ariles2::ns_rapidjson::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_octave::Writer, ariles2::ns_namevalue2::Writer, ariles2::ns_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_msgpack_compact::Writer, ariles2::ns_msgpack::Writer, and ariles2::ns_graphviz::Visitor.

◆ getDefaultParameters()

template<class t_Derived , class t_Parameters , class t_ReturnType = void>

virtual const t_Parameters& ariles2::visitor::Base< t_Derived, t_Parameters, t_ReturnType >::getDefaultParameters ( ) const

inlinevirtualinherited

Definition at line 52 of file common.h.

◆ getParameters()

template<class t_Derived , class t_Parameters , class t_ReturnType = void>

template<class t_Ariles >

const t_Parameters& ariles2::visitor::Base< t_Derived, t_Parameters, t_ReturnType >::getParameters ( const t_Ariles & ariles_class ) const

inlineinherited

Definition at line 60 of file common.h.

◆ startArray()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startArray	(	const std::size_t	size,
		const bool	compact = `false`
	)

pure virtual

Implemented in ariles2::ns_yaml_cpp::Writer, ariles2::ns_rosparam::Writer, ariles2::ns_ros2param::Writer, ariles2::ns_ros2param::Declarator, ariles2::ns_rapidjson::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_namevalue2::Writer, ariles2::ns_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_msgpack_compact::Writer, ariles2::ns_msgpack::Writer, ariles2::ns_octave::Writer, and ariles2::ns_graphviz::Visitor.

◆ startArrayElement()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startArrayElement ( )

inlinevirtual

Reimplemented in ariles2::ns_rosparam::Writer, ariles2::ns_ros2param::Writer, ariles2::ns_ros2param::Declarator, ariles2::ns_rapidjson::Writer, and ariles2::ns_pugixml::Writer.

Definition at line 119 of file write.h.

◆ startIteratedMap()

template<class t_Derived , class t_Parameters >

virtual bool ariles2::write::VisitorBase< t_Derived, t_Parameters >::startIteratedMap	(	const std::size_t	num_entries,
		const t_Parameters &	param
	)

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer, ariles2::ns_namevalue2::Writer, ariles2::ns_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_msgpack_compact::Writer, and ariles2::ns_msgpack::Writer.

Definition at line 99 of file write.h.

◆ startIteratedMapElement()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startIteratedMapElement ( const std::string & map_name )

inlinevirtual

Definition at line 104 of file write.h.

◆ startMap()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startMap	(	const t_Parameters &	,
		const std::size_t
	)

inlinevirtual

Starts a nested map in the configuration file.

Parameters

[in]	param	parameters
[in]	num_entries	number of child entries

Reimplemented in ariles2::ns_yaml_cpp::Writer, ariles2::ns_rapidjson::Writer, ariles2::ns_namevalue2::Writer, ariles2::ns_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_msgpack_compact::Writer, ariles2::ns_msgpack::Writer, and ariles2::ns_graphviz::Visitor.

Definition at line 76 of file write.h.

◆ startMapEntry()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startMapEntry ( const std::string & map_name )

inlinevirtual

Starts a nested map in the configuration file.

Parameters

[in] map_name name of the map

Reimplemented in ariles2::ns_yaml_cpp::Writer, ariles2::ns_rosparam::Writer, ariles2::ns_rapidjson::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_octave::Writer, ariles2::ns_namevalue2::Writer, ariles2::ns_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_msgpack::Writer, ariles2::ns_graphviz::Visitor, ariles2::ns_ros2param::Writer, and ariles2::ns_ros2param::Declarator.

Definition at line 84 of file write.h.

◆ startMatrix()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startMatrix	(	const bool	dynamic,
		const std::size_t	cols,
		const std::size_t	rows,
		const t_Parameters &	param
	)

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer.

Definition at line 155 of file write.h.

◆ startMatrixElement()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startMatrixElement ( )

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer.

Definition at line 195 of file write.h.

◆ startMatrixRow()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startMatrixRow	(	const std::size_t	cols,
		const t_Parameters &	param
	)

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer.

Definition at line 186 of file write.h.

◆ startPointer()

template<class t_Derived , class t_Parameters >

void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startPointer	(	const bool	is_null,
		const t_Parameters &	param
	)

inline

Definition at line 235 of file write.h.

◆ startRoot()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startRoot	(	const std::string &	name,
		const t_Parameters &
	)

inlinevirtual

Reimplemented in ariles2::ns_namevalue2::Writer, ariles2::ns_yaml_cpp::Writer, ariles2::ns_rosparam::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_msgpack::Writer, and ariles2::ns_graphviz::Visitor.

Definition at line 48 of file write.h.

◆ startVector()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startVector ( const std::size_t size )

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer.

Definition at line 133 of file write.h.

◆ startVectorElement()

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::startVectorElement ( )

inlinevirtual

Reimplemented in ariles2::ns_octave::Writer.

Definition at line 138 of file write.h.

◆ visit()

template<class t_Derived , class t_Parameters >

template<typename t_Entry >

ARILES2_BASIC_TYPES_LIST void ariles2::write::VisitorBase< t_Derived, t_Parameters >::visit	(	const t_Entry &	entry,
		const std::string &	entry_name,
		const t_Parameters &	param
	)

inline

Definition at line 292 of file write.h.

◆ visitArrayElement()

template<class t_Derived , class t_Parameters >

template<typename t_Element >

void ariles2::write::VisitorBase< t_Derived, t_Parameters >::visitArrayElement	(	const t_Element &	element,
		const t_Parameters &	param
	)

inline

Definition at line 319 of file write.h.

◆ visitMapEntry()

template<class t_Derived , class t_Parameters >

template<typename t_Entry >

void ariles2::write::VisitorBase< t_Derived, t_Parameters >::visitMapEntry	(	const t_Entry &	entry,
		const std::string &	entry_name,
		const t_Parameters &	param
	)

inline

Definition at line 302 of file write.h.

◆ visitMatrixElement()

template<class t_Derived , class t_Parameters >

template<typename t_Element >

void ariles2::write::VisitorBase< t_Derived, t_Parameters >::visitMatrixElement	(	const t_Element &	element,
		const t_Parameters &	param
	)

inline

Definition at line 340 of file write.h.

◆ visitVectorElement()

template<class t_Derived , class t_Parameters >

template<typename t_Element >

void ariles2::write::VisitorBase< t_Derived, t_Parameters >::visitVectorElement	(	const t_Element &	element,
		const t_Parameters &	param
	)

inline

Definition at line 330 of file write.h.

◆ writeElement() [1/3]

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::writeElement	(	const std::complex< double > &	entry,
		const t_Parameters &	param
	)

inlinevirtual

Definition at line 279 of file write.h.

◆ writeElement() [2/3]

template<class t_Derived , class t_Parameters >

virtual void ariles2::write::VisitorBase< t_Derived, t_Parameters >::writeElement	(	const std::complex< float > &	entry,
		const t_Parameters &	param
	)

inlinevirtual

Definition at line 275 of file write.h.

◆ writeElement() [3/3]

template<class t_Derived , class t_Parameters >

template<class t_Scalar >

void ariles2::write::VisitorBase< t_Derived, t_Parameters >::writeElement	(	const std::complex< t_Scalar > &	entry,
		const t_Parameters &	param
	)

inline

Definition at line 264 of file write.h.

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

include/ariles2/visitors/write.h

Detailed Description

template<class t_Derived, class t_Parameters> class ariles2::write::VisitorBase< t_Derived, t_Parameters >

Public Types

Public Member Functions

Member Typedef Documentation

◆ Parameters

◆ ReturnType

Member Function Documentation

◆ endArray()

◆ endArrayElement()

◆ endIteratedMap()

◆ endIteratedMapElement()

◆ endMap()

◆ endMapEntry()

◆ endMatrix()

◆ endMatrixElement()

◆ endMatrixRow()

◆ endPointer()

◆ endRoot()

◆ endVector()

◆ endVectorElement()

◆ flush()

◆ getDefaultParameters()

◆ getParameters()

◆ startArray()

◆ startArrayElement()

◆ startIteratedMap()

◆ startIteratedMapElement()

◆ startMap()

◆ startMapEntry()

◆ startMatrix()

◆ startMatrixElement()

◆ startMatrixRow()

◆ startPointer()

◆ startRoot()

◆ startVector()

◆ startVectorElement()

◆ visit()

◆ visitArrayElement()

◆ visitMapEntry()

◆ visitMatrixElement()

◆ visitVectorElement()

◆ writeElement() [1/3]

◆ writeElement() [2/3]

◆ writeElement() [3/3]

template<class t_Derived, class t_Parameters>
class ariles2::write::VisitorBase< t_Derived, t_Parameters >