Ariles
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
ariles::ns_octave::Writer Class Reference

Detailed Description

Configuration writer class.

Definition at line 33 of file octave.h.

#include <octave.h>

Inheritance diagram for ariles::ns_octave::Writer:
ariles::write::Visitor ariles::serialization::Base ariles::visitor::Base< ariles::ConfigurableFlags > ariles::visitor::Visitor

Public Types

typedef ariles::ConfigurableFlags Parameters
 

Public Member Functions

 Writer (const std::string &file_name)
 
 Writer (std::ostream &output_stream)
 
const serialization::Features & getSerializationFeatures () const
 
void flush ()
 Flush the configuration to the output. More...
 
void descend (const std::string &map_name)
 Starts a nested map in the configuration file. More...
 
void ascend ()
 
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 startArray (const std::size_t size, const bool compact=false)
 
void shiftArray ()
 
void endArray ()
 
void startMatrix (const bool compact=false)
 
void startMatrixRow ()
 
void endMatrixRow ()
 
void endMatrix ()
 
virtual void startRoot (const std::string &name)
 
virtual void endRoot (const std::string &name)
 
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_octave::Writer::Impl
protected

Definition at line 36 of file octave.h.

◆ ImplPtr

typedef ARILES_SHARED_PTR<impl::Writer> ariles::ns_octave::Writer::ImplPtr
protected

Definition at line 37 of file octave.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_octave::Writer::Writer ( const std::string &  file_name)
explicit

Definition at line 77 of file writer.cpp.

◆ Writer() [2/2]

ariles::ns_octave::Writer::Writer ( std::ostream &  output_stream)
explicit

Definition at line 83 of file writer.cpp.

Member Function Documentation

◆ ascend()

void ariles::ns_octave::Writer::ascend ( )
virtual

Reimplemented from ariles::write::Visitor.

Definition at line 127 of file writer.cpp.

◆ descend()

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

Starts a nested map in the configuration file.

Parameters
[in]map_namename of the map

Reimplemented from ariles::write::Visitor.

Definition at line 103 of file writer.cpp.

◆ endArray()

void ariles::ns_octave::Writer::endArray ( )
virtual

Reimplemented from ariles::write::Visitor.

Definition at line 155 of file writer.cpp.

◆ endMap()

void ariles::ns_octave::Writer::endMap ( )
inlinevirtual

Ends a nested map in the configuration file.

Reimplemented from ariles::write::Visitor.

Definition at line 59 of file octave.h.

◆ endMatrix()

void ariles::ns_octave::Writer::endMatrix ( )
virtual

Reimplemented from ariles::write::Visitor.

Definition at line 194 of file writer.cpp.

◆ endMatrixRow()

void ariles::ns_octave::Writer::endMatrixRow ( )
virtual

Reimplemented from ariles::write::Visitor.

Definition at line 182 of file writer.cpp.

◆ endRoot()

virtual void ariles::write::Visitor::endRoot ( const std::string &  name)
inlinevirtualinherited

Reimplemented in ariles::ns_msgpack::Writer, ariles::ns_pugixml::Writer, ariles::ns_ros::Writer, and ariles::ns_yaml_cpp::Writer.

Definition at line 112 of file write.h.

◆ flush()

void ariles::ns_octave::Writer::flush ( )
virtual

Flush the configuration to the output.

Implements ariles::write::Visitor.

Definition at line 96 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_octave::Writer::getSerializationFeatures ( ) const
virtual

Implements ariles::serialization::Base.

Definition at line 89 of file writer.cpp.

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

void ariles::ns_octave::Writer::shiftArray ( )
virtual

Reimplemented from ariles::write::Visitor.

Definition at line 149 of file writer.cpp.

◆ 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_octave::Writer::startArray ( const std::size_t  size,
const bool  compact = false 
)
virtual

Implements ariles::write::Visitor.

Definition at line 133 of file writer.cpp.

◆ startMap()

void ariles::ns_octave::Writer::startMap ( const std::size_t  num_entries)
inlinevirtual

Starts a nested map in the configuration file.

Parameters
[in]num_entriesnumber of child entries

Reimplemented from ariles::write::Visitor.

Definition at line 56 of file octave.h.

◆ startMatrix()

void ariles::ns_octave::Writer::startMatrix ( const bool  compact = false)
virtual

Reimplemented from ariles::write::Visitor.

Definition at line 161 of file writer.cpp.

◆ startMatrixRow()

void ariles::ns_octave::Writer::startMatrixRow ( )
virtual

Reimplemented from ariles::write::Visitor.

Definition at line 177 of file writer.cpp.

◆ startRoot()

virtual void ariles::write::Visitor::startRoot ( const std::string &  name)
inlinevirtualinherited

Reimplemented in ariles::ns_msgpack::Writer, ariles::ns_pugixml::Writer, ariles::ns_ros::Writer, and ariles::ns_yaml_cpp::Writer.

Definition at line 104 of file write.h.

Member Data Documentation

◆ impl_

ImplPtr ariles::ns_octave::Writer::impl_
protected

Definition at line 38 of file octave.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.15