Ariles
Public Member Functions | Protected Member Functions | List of all members
ariles::CommonConfigurableBase Class Referenceabstract

Detailed Description

Configurable base class.

Definition at line 64 of file ariles.h.

#include <ariles.h>

Inheritance diagram for ariles::CommonConfigurableBase:
ariles::Base< t_B0, t_B1, t_B2, t_B3, t_B4, t_B5, t_B6, t_B7, t_B8, t_B9 > ariles::ConfigurableBase ariles::RelaxedConfigurableBase ariles::StrictConfigurableBase ariles::Any< t_Pointer, t_Base, t_Instantiator > ariles::NonNullPointer< t_Pointer > demo::ArilesBaseClass demo::MyContainerClass demo::MyClass demo::MyClass

Public Member Functions

virtual void setDefaults ()
 
virtual void arilesFinalize ()=0
 
virtual void finalize ()
 
virtual std::size_t getNumberOfEntries () const =0
 Get number of entries in the corresponding configuration node. More...
 
virtual const std::string & getConfigSectionID () const =0
 Return the default name of a configuration node corresponding to this class. More...
 
virtual const ConfigurableFlags & getArilesConfigurableFlags () const =0
 
virtual void readConfigEntries (ariles::ReaderBase &visitor, const ariles::ReaderBase::Parameters &parameters)
 
void readConfig (ariles::ReaderBase &reader, const ariles::ConfigurableFlags &param)
 Read configuration (assuming the configuration node to be in the root). More...
 
void readConfig (ariles::ReaderBase &reader)
 
virtual void readConfig (ariles::ReaderBase &reader, const std::string &node_name, const ariles::ReaderBase::Parameters &param)=0
 
void readConfig (ariles::ReaderBase &reader, const std::string &node_name)
 
virtual void readConfig (ariles::ReaderBase &reader, const char *node_name, const ariles::ReaderBase::Parameters &param)=0
 
void readConfig (ariles::ReaderBase &reader, const char *node_name)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (t_ReaderInitializer &reader_initializer)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (t_ReaderInitializer &reader_initializer, const ariles::ConfigurableFlags &param)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (const t_ReaderInitializer &reader_initializer)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (const t_ReaderInitializer &reader_initializer, const ariles::ConfigurableFlags &param)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (t_ReaderInitializer &reader_initializer, const std::string &node_name)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (t_ReaderInitializer &reader_initializer, const std::string &node_name, const ariles::ConfigurableFlags &param)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (const t_ReaderInitializer &reader_initializer, const std::string &node_name)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (const t_ReaderInitializer &reader_initializer, const std::string &node_name, const ariles::ConfigurableFlags &param)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (t_ReaderInitializer &reader_initializer, const char *node_name)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (t_ReaderInitializer &reader_initializer, const char *node_name, const ariles::ConfigurableFlags &param)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (const t_ReaderInitializer &reader_initializer, const char *node_name)
 
template<class t_Bridge , class t_ReaderInitializer >
void readConfig (const t_ReaderInitializer &reader_initializer, const char *node_name, const ariles::ConfigurableFlags &param)
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (t_WriterInitializer &writer_initializer) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (t_WriterInitializer &writer_initializer, const ariles::ConfigurableFlags &param) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (const t_WriterInitializer &writer_initializer) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (const t_WriterInitializer &writer_initializer, const ariles::ConfigurableFlags &param) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (t_WriterInitializer &writer_initializer, const std::string &node_name) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (t_WriterInitializer &writer_initializer, const std::string &node_name, const ariles::ConfigurableFlags &param) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (const t_WriterInitializer &writer_initializer, const std::string &node_name) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (const t_WriterInitializer &writer_initializer, const std::string &node_name, const ariles::ConfigurableFlags &param) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (t_WriterInitializer &writer_initializer, const char *node_name) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (t_WriterInitializer &writer_initializer, const char *node_name, const ariles::ConfigurableFlags &param) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (const t_WriterInitializer &writer_initializer, const char *node_name) const
 
template<class t_Bridge , class t_WriterInitializer >
void writeConfig (const t_WriterInitializer &writer_initializer, const char *node_name, const ariles::ConfigurableFlags &param) const
 
void writeConfig (ariles::WriterBase &writer, const ariles::ConfigurableFlags &param) const
 Write configuration. More...
 
void writeConfig (ariles::WriterBase &writer) const
 
virtual void writeConfig (ariles::WriterBase &writer, const std::string &node_name, const ariles::ConfigurableFlags &param) const =0
 
void writeConfig (ariles::WriterBase &writer, const std::string &node_name) const
 
virtual void writeConfig (ariles::WriterBase &writer, const char *node_name, const ariles::ConfigurableFlags &param) const =0
 
void writeConfig (ariles::WriterBase &writer, const char *node_name) const
 
virtual void writeConfigEntries (ariles::WriterBase &visitor, const ariles::WriterBase::Parameters &param) const
 

Protected Member Functions

 ~CommonConfigurableBase ()
 Protected destructor: prevent destruction of the child classes through a base pointer. More...
 
 CommonConfigurableBase ()
 

Constructor & Destructor Documentation

◆ ~CommonConfigurableBase()

ariles::CommonConfigurableBase::~CommonConfigurableBase ( )
inlineprotected

Protected destructor: prevent destruction of the child classes through a base pointer.

Definition at line 71 of file ariles.h.

◆ CommonConfigurableBase()

ariles::CommonConfigurableBase::CommonConfigurableBase ( )
inlineprotected

Definition at line 74 of file ariles.h.

Member Function Documentation

◆ arilesFinalize()

virtual void ariles::CommonConfigurableBase::arilesFinalize ( )
pure virtual

Implemented in ariles::NonNullPointer< t_Pointer >, and ariles::Any< t_Pointer, t_Base, t_Instantiator >.

◆ finalize()

virtual void ariles::CommonConfigurableBase::finalize ( )
inlinevirtual

Reimplemented in demo::MyContainerClass.

Definition at line 87 of file ariles.h.

◆ getArilesConfigurableFlags()

virtual const ConfigurableFlags& ariles::CommonConfigurableBase::getArilesConfigurableFlags ( ) const
pure virtual

Implemented in ariles::ConfigurableBase, ariles::RelaxedConfigurableBase, and ariles::StrictConfigurableBase.

◆ getConfigSectionID()

virtual const std::string& ariles::CommonConfigurableBase::getConfigSectionID ( ) const
pure virtual

Return the default name of a configuration node corresponding to this class.

Returns
the name
Attention
Implementation of this method is added automatically upon inclusion of define_accessors.h if ARILES_SECTION_ID is defined.

◆ getNumberOfEntries()

virtual std::size_t ariles::CommonConfigurableBase::getNumberOfEntries ( ) const
pure virtual

Get number of entries in the corresponding configuration node.

Returns
number of entries

Implemented in ariles::NonNullPointer< t_Pointer >, and ariles::Any< t_Pointer, t_Base, t_Instantiator >.

◆ readConfig() [1/18]

void ariles::CommonConfigurableBase::readConfig ( ariles::ReaderBase &  reader,
const ariles::ConfigurableFlags &  param 
)
inline

Read configuration (assuming the configuration node to be in the root).

Parameters
[in]readerconfiguration reader

Definition at line 129 of file ariles.h.

◆ readConfig() [2/18]

void ariles::CommonConfigurableBase::readConfig ( ariles::ReaderBase &  reader)
inline

Definition at line 135 of file ariles.h.

◆ readConfig() [3/18]

virtual void ariles::CommonConfigurableBase::readConfig ( ariles::ReaderBase &  reader,
const std::string &  node_name,
const ariles::ReaderBase::Parameters &  param 
)
pure virtual

◆ readConfig() [4/18]

void ariles::CommonConfigurableBase::readConfig ( ariles::ReaderBase &  reader,
const std::string &  node_name 
)
inline

Definition at line 160 of file ariles.h.

◆ readConfig() [5/18]

virtual void ariles::CommonConfigurableBase::readConfig ( ariles::ReaderBase &  reader,
const char *  node_name,
const ariles::ReaderBase::Parameters &  param 
)
pure virtual

◆ readConfig() [6/18]

void ariles::CommonConfigurableBase::readConfig ( ariles::ReaderBase &  reader,
const char *  node_name 
)
inline

Definition at line 161 of file ariles.h.

◆ readConfig() [7/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( t_ReaderInitializer &  reader_initializer)
inline

Definition at line 188 of file ariles.h.

◆ readConfig() [8/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( t_ReaderInitializer &  reader_initializer,
const ariles::ConfigurableFlags &  param 
)
inline

Definition at line 188 of file ariles.h.

◆ readConfig() [9/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( const t_ReaderInitializer &  reader_initializer)
inline

Definition at line 189 of file ariles.h.

◆ readConfig() [10/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( const t_ReaderInitializer &  reader_initializer,
const ariles::ConfigurableFlags &  param 
)
inline

Definition at line 189 of file ariles.h.

◆ readConfig() [11/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( t_ReaderInitializer &  reader_initializer,
const std::string &  node_name 
)
inline

Definition at line 220 of file ariles.h.

◆ readConfig() [12/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( t_ReaderInitializer &  reader_initializer,
const std::string &  node_name,
const ariles::ConfigurableFlags &  param 
)
inline

Definition at line 220 of file ariles.h.

◆ readConfig() [13/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( const t_ReaderInitializer &  reader_initializer,
const std::string &  node_name 
)
inline

Definition at line 221 of file ariles.h.

◆ readConfig() [14/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( const t_ReaderInitializer &  reader_initializer,
const std::string &  node_name,
const ariles::ConfigurableFlags &  param 
)
inline

Definition at line 221 of file ariles.h.

◆ readConfig() [15/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( t_ReaderInitializer &  reader_initializer,
const char *  node_name 
)
inline

Definition at line 222 of file ariles.h.

◆ readConfig() [16/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( t_ReaderInitializer &  reader_initializer,
const char *  node_name,
const ariles::ConfigurableFlags &  param 
)
inline

Definition at line 222 of file ariles.h.

◆ readConfig() [17/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( const t_ReaderInitializer &  reader_initializer,
const char *  node_name 
)
inline

Definition at line 223 of file ariles.h.

◆ readConfig() [18/18]

template<class t_Bridge , class t_ReaderInitializer >
void ariles::CommonConfigurableBase::readConfig ( const t_ReaderInitializer &  reader_initializer,
const char *  node_name,
const ariles::ConfigurableFlags &  param 
)
inline

Definition at line 223 of file ariles.h.

◆ readConfigEntries()

virtual void ariles::CommonConfigurableBase::readConfigEntries ( ariles::ReaderBase &  visitor,
const ariles::ReaderBase::Parameters &  parameters 
)
inlinevirtual

Reimplemented in ariles::NonNullPointer< t_Pointer >, and ariles::Any< t_Pointer, t_Base, t_Instantiator >.

Definition at line 116 of file ariles.h.

◆ setDefaults()

virtual void ariles::CommonConfigurableBase::setDefaults ( )
inlinevirtual

Reimplemented in ariles::NonNullPointer< t_Pointer >, ariles::Any< t_Pointer, t_Base, t_Instantiator >, demo::MyClass, and demo::ArilesBaseClass.

Definition at line 79 of file ariles.h.

◆ writeConfig() [1/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( t_WriterInitializer &  writer_initializer,
const ariles::ConfigurableFlags &  param 
) const
inline

Definition at line 244 of file ariles.h.

◆ writeConfig() [2/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( t_WriterInitializer &  writer_initializer) const
inline

Definition at line 244 of file ariles.h.

◆ writeConfig() [3/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( const t_WriterInitializer &  writer_initializer,
const ariles::ConfigurableFlags &  param 
) const
inline

Definition at line 245 of file ariles.h.

◆ writeConfig() [4/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( const t_WriterInitializer &  writer_initializer) const
inline

Definition at line 245 of file ariles.h.

◆ writeConfig() [5/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( t_WriterInitializer &  writer_initializer,
const std::string &  node_name,
const ariles::ConfigurableFlags &  param 
) const
inline

Definition at line 272 of file ariles.h.

◆ writeConfig() [6/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( t_WriterInitializer &  writer_initializer,
const std::string &  node_name 
) const
inline

Definition at line 272 of file ariles.h.

◆ writeConfig() [7/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( const t_WriterInitializer &  writer_initializer,
const std::string &  node_name 
) const
inline

Definition at line 273 of file ariles.h.

◆ writeConfig() [8/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( const t_WriterInitializer &  writer_initializer,
const std::string &  node_name,
const ariles::ConfigurableFlags &  param 
) const
inline

Definition at line 273 of file ariles.h.

◆ writeConfig() [9/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( t_WriterInitializer &  writer_initializer,
const char *  node_name,
const ariles::ConfigurableFlags &  param 
) const
inline

Definition at line 274 of file ariles.h.

◆ writeConfig() [10/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( t_WriterInitializer &  writer_initializer,
const char *  node_name 
) const
inline

Definition at line 274 of file ariles.h.

◆ writeConfig() [11/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( const t_WriterInitializer &  writer_initializer,
const char *  node_name 
) const
inline

Definition at line 275 of file ariles.h.

◆ writeConfig() [12/18]

template<class t_Bridge , class t_WriterInitializer >
void ariles::CommonConfigurableBase::writeConfig ( const t_WriterInitializer &  writer_initializer,
const char *  node_name,
const ariles::ConfigurableFlags &  param 
) const
inline

Definition at line 275 of file ariles.h.

◆ writeConfig() [13/18]

void ariles::CommonConfigurableBase::writeConfig ( ariles::WriterBase &  writer,
const ariles::ConfigurableFlags &  param 
) const
inline

Write configuration.

Parameters
[in,out]writerconfiguration writer

Definition at line 286 of file ariles.h.

◆ writeConfig() [14/18]

void ariles::CommonConfigurableBase::writeConfig ( ariles::WriterBase &  writer) const
inline

Definition at line 290 of file ariles.h.

◆ writeConfig() [15/18]

void ariles::CommonConfigurableBase::writeConfig ( ariles::WriterBase &  writer,
const std::string &  node_name 
) const
inline

Definition at line 310 of file ariles.h.

◆ writeConfig() [16/18]

virtual void ariles::CommonConfigurableBase::writeConfig ( ariles::WriterBase &  writer,
const std::string &  node_name,
const ariles::ConfigurableFlags &  param 
) const
pure virtual

◆ writeConfig() [17/18]

void ariles::CommonConfigurableBase::writeConfig ( ariles::WriterBase &  writer,
const char *  node_name 
) const
inline

Definition at line 311 of file ariles.h.

◆ writeConfig() [18/18]

virtual void ariles::CommonConfigurableBase::writeConfig ( ariles::WriterBase &  writer,
const char *  node_name,
const ariles::ConfigurableFlags &  param 
) const
pure virtual

◆ writeConfigEntries()

virtual void ariles::CommonConfigurableBase::writeConfigEntries ( ariles::WriterBase &  visitor,
const ariles::WriterBase::Parameters &  param 
) const
inlinevirtual

Reimplemented in ariles::NonNullPointer< t_Pointer >, and ariles::Any< t_Pointer, t_Base, t_Instantiator >.

Definition at line 317 of file ariles.h.

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