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
typedef Parameters	Parameters

typedef void	ReturnType

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)

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 ARILES2_SHARED_PTR< impl::Writer >	ImplPtr

Protected Member Functions
const Parameters &	getDefaultParameters () const

Protected Attributes
ImplPtr	impl_

Member Typedef Documentation

◆ Impl

typedef impl::Writer ariles2::ns_octave::Writer::Impl

protected

Definition at line 48 of file octave.h.

◆ ImplPtr

typedef ARILES2_SHARED_PTR<impl::Writer> ariles2::ns_octave::Writer::ImplPtr

protected

Definition at line 49 of file octave.h.

◆ Parameters

typedef Parameters ariles2::serialization::Base< Visitor , Parameters >::Parameters

inherited

Definition at line 144 of file serialization.h.

◆ ReturnType

typedef void ariles2::visitor::Base< visitor::GenericVisitor , Parameters , void >::ReturnType

inherited

Definition at line 53 of file common.h.

Constructor & Destructor Documentation

◆ Writer() [1/2]

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

explicit

Definition at line 97 of file writer.cpp.

◆ Writer() [2/2]

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

explicit

Definition at line 103 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 168 of file writer.cpp.

◆ endArrayElement()

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

virtual

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

Definition at line 162 of file writer.cpp.

◆ endIteratedMap()

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

inlinevirtualinherited

Definition at line 133 of file write.h.

◆ endIteratedMapElement()

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

inlinevirtualinherited

Definition at line 129 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_namevalue::GenericWriter< t_NameValuePair >, and ariles2::ns_yaml_cpp::Writer.

Definition at line 115 of file write.h.

◆ endMapEntry()

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

virtual

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

Definition at line 140 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 230 of file writer.cpp.

◆ endMatrixElement()

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

virtual

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

Definition at line 220 of file writer.cpp.

◆ endMatrixRow()

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

virtual

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

Definition at line 225 of file writer.cpp.

◆ endPointer()

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

inlineinherited

Definition at line 274 of file write.h.

◆ endRoot()

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

inlinevirtualinherited

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

Definition at line 77 of file write.h.

◆ endVector()

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

virtual

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

Definition at line 189 of file writer.cpp.

◆ endVectorElement()

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

virtual

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

Definition at line 184 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 109 of file writer.cpp.

◆ getDefaultParameters()

const Parameters & ariles2::visitor::Base< visitor::GenericVisitor , Parameters , void >::getDefaultParameters ( ) const

inlineprotectedinherited

Definition at line 59 of file common.h.

◆ getParameters()

const Parameters & ariles2::serialization::Base< Visitor , Parameters >::getParameters ( const t_Ariles & ariles_class ) const

inlineinherited

Definition at line 151 of file serialization.h.

◆ openFile()

static void ariles2::write::VisitorBase< Visitor , Parameters >::openFile	(	std::ofstream &	config_ofs,
		const std::string &	file_name
	)

inlinestaticinherited

open configuration file

Parameters

[out]	config_ofs
[in]	file_name

Definition at line 58 of file write.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 146 of file writer.cpp.

◆ startArrayElement()

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

inlinevirtualinherited

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

Definition at line 140 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 67 of file octave.h.

◆ startIteratedMapElement()

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

inlinevirtualinherited

Definition at line 125 of file write.h.

◆ startMap() [1/2]

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

inlinevirtualinherited

Starts a nested map in the configuration file.

Parameters

[in]	instance_id	instance id
[in]	num_entries	number of child entries

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

Definition at line 97 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 379 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 116 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 196 of file writer.cpp.

◆ startMatrixElement()

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

virtual

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

Definition at line 212 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 207 of file writer.cpp.

◆ startPointer()

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

inlineinherited

Definition at line 256 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_msgpack::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_rosparam::Writer, and ariles2::ns_yaml_cpp::Writer.

Definition at line 69 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 174 of file writer.cpp.

◆ startVectorElement()

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

virtual

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

Definition at line 180 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 313 of file write.h.

◆ visitArrayElement()

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

inlineinherited

Definition at line 335 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 323 of file write.h.

◆ visitMatrixElement()

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

inlineinherited

Definition at line 356 of file write.h.

◆ visitVectorElement()

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

inlineinherited

Definition at line 346 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 300 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 296 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 285 of file write.h.

Member Data Documentation

◆ impl_

ImplPtr ariles2::ns_octave::Writer::impl_

protected

Definition at line 52 of file octave.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

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

◆ openFile()

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