Ariles
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
ariles2::write::VisitorBase< t_Derived, t_Parameters > Class Template Referenceabstract

Detailed Description

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

Definition at line 44 of file write.h.

#include <write.h>

Inheritance diagram for ariles2::write::VisitorBase< t_Derived, t_Parameters >:
ariles2::serialization::Base< t_Derived, t_Parameters > ariles2::visitor::Base< visitor::GenericVisitor, t_Parameters > ariles2::visitor::GenericVisitor ariles2::visitor::Visitor

Public Types

typedef t_Parameters Parameters
 
typedef void ReturnType
 

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)
 
template<class t_Ariles >
const t_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 Member Functions

 VisitorBase ()
 
 ~VisitorBase ()
 
const t_Parameters & getDefaultParameters () const
 

Member Typedef Documentation

◆ Parameters

template<class t_Derived , class t_Parameters >
typedef t_Parameters ariles2::serialization::Base< t_Derived, t_Parameters >::Parameters
inherited

Definition at line 144 of file serialization.h.

◆ ReturnType

typedef void ariles2::visitor::Base< visitor::GenericVisitor , t_Parameters, void >::ReturnType
inherited

Definition at line 53 of file common.h.

Constructor & Destructor Documentation

◆ VisitorBase()

template<class t_Derived , class t_Parameters >
ariles2::write::VisitorBase< t_Derived, t_Parameters >::VisitorBase ( )
inlineprotected

Definition at line 47 of file write.h.

◆ ~VisitorBase()

template<class t_Derived , class t_Parameters >
ariles2::write::VisitorBase< t_Derived, t_Parameters >::~VisitorBase ( )
inlineprotected

Definition at line 48 of file write.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_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_graphviz::Visitor, ariles2::ns_octave::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_rapidjson::Writer, ariles2::ns_rosparam::Writer, and ariles2::ns_yaml_cpp::Writer.

Definition at line 148 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_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_graphviz::Visitor, ariles2::ns_octave::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_rapidjson::Writer, and ariles2::ns_rosparam::Writer.

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

Definition at line 115 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_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_graphviz::Visitor, ariles2::ns_octave::Writer, ariles2::ns_rosparam::Writer, ariles2::ns_pugixml::Writer, and ariles2::ns_rapidjson::Writer.

Definition at line 109 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 235 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 221 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 226 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 274 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_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()

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 169 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 164 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_graphviz::Visitor, ariles2::ns_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_octave::Writer, ariles2::ns_msgpack::Writer, ariles2::ns_msgpack_compact::Writer, ariles2::ns_yaml_cpp::Writer, ariles2::ns_rosparam::Writer, ariles2::ns_pugixml::Writer, and ariles2::ns_rapidjson::Writer.

◆ getDefaultParameters()

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

Definition at line 59 of file common.h.

◆ getParameters()

template<class t_Derived , class t_Parameters >
template<class t_Ariles >
const t_Parameters& ariles2::serialization::Base< t_Derived, t_Parameters >::getParameters ( const t_Ariles &  ariles_class) const
inlineinherited

Definition at line 151 of file serialization.h.

◆ openFile()

template<class t_Derived , class t_Parameters >
static void ariles2::write::VisitorBase< t_Derived, t_Parameters >::openFile ( std::ofstream &  config_ofs,
const std::string &  file_name 
)
inlinestatic

open configuration file

Parameters
[out]config_ofs
[in]file_name

Definition at line 58 of file write.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_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_msgpack::Writer, ariles2::ns_msgpack_compact::Writer, ariles2::ns_pugixml::Writer, ariles2::ns_rapidjson::Writer, ariles2::ns_rosparam::Writer, ariles2::ns_graphviz::Visitor, and ariles2::ns_octave::Writer.

◆ startArrayElement()

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

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

Definition at line 140 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_namevalue::GenericWriter< t_NameValuePair >, ariles2::ns_octave::Writer, ariles2::ns_msgpack::Writer, and ariles2::ns_msgpack_compact::Writer.

Definition at line 120 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 125 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]instance_idinstance id
[in]num_entriesnumber 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.

◆ 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_namename of the map

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

Definition at line 105 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 176 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 216 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 207 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 256 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_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()

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 154 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 159 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 313 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 335 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 323 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 356 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 346 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 300 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 296 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 285 of file write.h.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17