Detailed Description

Configuration writer class.

Definition at line 45 of file octave.h.

#include <octave.h>

Inheritance diagram for ariles2::ns_octave::Writer:

Public Types
using	ReturnType = t_ReturnType

using	Parameters = t_Parameters

Public Member Functions
	Writer (const std::string &file_name)

	Writer (std::ostream &output_stream)

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

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

void	endMapEntry ()

bool	startIteratedMap (const std::size_t, const Parameters &)

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

void	endArrayElement ()

void	endArray ()

void	startVector (const std::size_t size)

void	startVectorElement ()

void	endVectorElement ()

void	endVector ()

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

void	startMatrixRow (const std::size_t, const Parameters &)

void	startMatrixElement ()

void	endMatrixElement ()

void	endMatrixRow (const Parameters &)

void	endMatrix (const bool dynamic, const Parameters &)

template<class t_Entry >
void	startMap (t_Entry &entry, const Parameters &parameters)

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

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

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

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

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

virtual void	endIteratedMapElement ()

virtual void	endIteratedMap ()

virtual void	startArrayElement ()

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

void	endPointer (const bool is_null)

void	writeElement (const std::complex< t_Scalar > &entry, const Parameters &param)

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

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

ARILES2_BASIC_TYPES_LIST void	visit (const t_Entry &entry, const std::string &entry_name, const Parameters &param)

void	visitMapEntry (const t_Entry &entry, const std::string &entry_name, const Parameters &param)

void	visitArrayElement (const t_Element &element, const Parameters &param)

void	visitVectorElement (const t_Element &element, const Parameters &param)

void	visitMatrixElement (const t_Element &element, const Parameters &param)

virtual const t_Parameters &	getDefaultParameters () const

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

Protected Types
using	Impl = impl::Writer

using	ImplPtr = std::shared_ptr< impl::Writer >

Protected Member Functions
void	makeImplPtr (t_Args &&...args)

Protected Attributes
ImplPtr	impl_

Member Typedef Documentation

◆ Impl

using ariles2::serialization::PIMPLVisitor< write::Visitor , impl::Writer >::Impl = impl::Writer

protectedinherited

Definition at line 187 of file serialization.h.

◆ ImplPtr

using ariles2::serialization::PIMPLVisitor< write::Visitor , impl::Writer >::ImplPtr = std::shared_ptr<impl::Writer >

protectedinherited

Definition at line 188 of file serialization.h.

◆ 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.

Constructor & Destructor Documentation

◆ Writer() [1/2]

ariles2::ns_octave::Writer::Writer ( const std::string & file_name )

explicit

Definition at line 86 of file writer.cpp.

◆ Writer() [2/2]

ariles2::ns_octave::Writer::Writer ( std::ostream & output_stream )

explicit

Definition at line 92 of file writer.cpp.

Member Function Documentation

◆ endArray()

void ariles2::ns_octave::Writer::endArray ( )

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 158 of file writer.cpp.

◆ endArrayElement()

void ariles2::ns_octave::Writer::endArrayElement ( )

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 153 of file writer.cpp.

◆ endIteratedMap()

virtual void ariles2::write::VisitorBase< Visitor , Parameters >::endIteratedMap ( )

inlinevirtualinherited

Definition at line 112 of file write.h.

◆ endIteratedMapElement()

virtual void ariles2::write::VisitorBase< Visitor , Parameters >::endIteratedMapElement ( )

inlinevirtualinherited

Definition at line 108 of file write.h.

◆ endMap()

virtual void ariles2::write::VisitorBase< Visitor , Parameters >::endMap ( )

inlinevirtualinherited

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

void ariles2::ns_octave::Writer::endMapEntry ( )

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 129 of file writer.cpp.

◆ endMatrix()

void ariles2::ns_octave::Writer::endMatrix	(	const bool	dynamic,
		const Parameters &
	)

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 219 of file writer.cpp.

◆ endMatrixElement()

void ariles2::ns_octave::Writer::endMatrixElement ( )

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 209 of file writer.cpp.

◆ endMatrixRow()

void ariles2::ns_octave::Writer::endMatrixRow ( const Parameters & )

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 214 of file writer.cpp.

◆ endPointer()

void ariles2::write::VisitorBase< Visitor , Parameters >::endPointer ( const bool is_null )

inlineinherited

Definition at line 253 of file write.h.

◆ endRoot()

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

inlinevirtualinherited

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

void ariles2::ns_octave::Writer::endVector ( )

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 179 of file writer.cpp.

◆ endVectorElement()

void ariles2::ns_octave::Writer::endVectorElement ( )

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 174 of file writer.cpp.

◆ flush()

void ariles2::ns_octave::Writer::flush ( )

virtual

Flush the configuration to the output.

Implements ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 98 of file writer.cpp.

◆ 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.

◆ makeImplPtr()

void ariles2::serialization::PIMPLVisitor< write::Visitor , impl::Writer >::makeImplPtr ( t_Args &&... args )

inlineprotectedinherited

Definition at line 202 of file serialization.h.

◆ startArray()

void ariles2::ns_octave::Writer::startArray	(	const std::size_t	size,
		const bool	compact = `false`
	)

virtual

Implements ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 135 of file writer.cpp.

◆ startArrayElement()

virtual void ariles2::write::VisitorBase< Visitor , Parameters >::startArrayElement ( )

inlinevirtualinherited

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

bool ariles2::ns_octave::Writer::startIteratedMap	(	const std::size_t	,
		const Parameters &
	)

inlinevirtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 59 of file octave.h.

◆ startIteratedMapElement()

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

inlinevirtualinherited

Definition at line 104 of file write.h.

◆ startMap() [1/2]

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

inlinevirtualinherited

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.

◆ startMap() [2/2]

template<class t_Entry >

void ariles2::write::Visitor::startMap	(	t_Entry &	entry,
		const Parameters &	parameters
	)

inlineinherited

Definition at line 359 of file write.h.

◆ startMapEntry()

void ariles2::ns_octave::Writer::startMapEntry ( const std::string & map_name )

virtual

Starts a nested map in the configuration file.

Parameters

[in] map_name name of the map

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 105 of file writer.cpp.

◆ startMatrix()

void ariles2::ns_octave::Writer::startMatrix	(	const bool	dynamic,
		const std::size_t	cols,
		const std::size_t	rows,
		const Parameters &	param
	)

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 186 of file writer.cpp.

◆ startMatrixElement()

void ariles2::ns_octave::Writer::startMatrixElement ( )

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 201 of file writer.cpp.

◆ startMatrixRow()

void ariles2::ns_octave::Writer::startMatrixRow	(	const std::size_t	,
		const Parameters &
	)

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 196 of file writer.cpp.

◆ startPointer()

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

inlineinherited

Definition at line 235 of file write.h.

◆ startRoot()

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

inlinevirtualinherited

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

void ariles2::ns_octave::Writer::startVector ( const std::size_t size )

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 164 of file writer.cpp.

◆ startVectorElement()

void ariles2::ns_octave::Writer::startVectorElement ( )

virtual

Reimplemented from ariles2::write::VisitorBase< Visitor, Parameters >.

Definition at line 170 of file writer.cpp.

◆ visit()

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

inlineinherited

Definition at line 292 of file write.h.

◆ visitArrayElement()

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

inlineinherited

Definition at line 319 of file write.h.

◆ visitMapEntry()

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

inlineinherited

Definition at line 302 of file write.h.

◆ visitMatrixElement()

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

inlineinherited

Definition at line 340 of file write.h.

◆ visitVectorElement()

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

inlineinherited

Definition at line 330 of file write.h.

◆ writeElement() [1/3]

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

inlinevirtualinherited

Definition at line 279 of file write.h.

◆ writeElement() [2/3]

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

inlinevirtualinherited

Definition at line 275 of file write.h.

◆ writeElement() [3/3]

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

inlineinherited

Definition at line 264 of file write.h.

Member Data Documentation

◆ impl_

ImplPtr ariles2::serialization::PIMPLVisitor< write::Visitor , impl::Writer >::impl_

protectedinherited

Definition at line 191 of file serialization.h.

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

extra_visitors/octave/ariles2/visitors/octave.h
extra_visitors/octave/src/writer.cpp

Detailed Description

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ Impl

◆ ImplPtr

◆ Parameters

◆ ReturnType

Constructor & Destructor Documentation

◆ Writer() [1/2]

◆ Writer() [2/2]

Member Function Documentation

◆ endArray()

◆ endArrayElement()

◆ endIteratedMap()

◆ endIteratedMapElement()

◆ endMap()

◆ endMapEntry()

◆ endMatrix()

◆ endMatrixElement()

◆ endMatrixRow()

◆ endPointer()

◆ endRoot()

◆ endVector()

◆ endVectorElement()

◆ flush()

◆ getDefaultParameters()

◆ getParameters()

◆ makeImplPtr()

◆ startArray()

◆ startArrayElement()

◆ startIteratedMap()

◆ startIteratedMapElement()

◆ startMap() [1/2]

◆ startMap() [2/2]

◆ startMapEntry()

◆ startMatrix()

◆ startMatrixElement()

◆ startMatrixRow()

◆ startPointer()

◆ startRoot()

◆ startVector()

◆ startVectorElement()

◆ visit()

◆ visitArrayElement()

◆ visitMapEntry()

◆ visitMatrixElement()

◆ visitVectorElement()

◆ writeElement() [1/3]

◆ writeElement() [2/3]

◆ writeElement() [3/3]

Member Data Documentation

◆ impl_