Ariles
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
ariles::Any< t_Pointer, t_Base, t_Instantiator > Class Template Referenceabstract

Detailed Description

template<template< class > class t_Pointer, class t_Base, class t_Instantiator>
class ariles::Any< t_Pointer, t_Base, t_Instantiator >

Definition at line 16 of file types.h.

#include <types.h>

Inheritance diagram for ariles::Any< t_Pointer, t_Base, t_Instantiator >:
ariles::ConfigurableBase ariles::CommonConfigurableBase ariles::Base< t_B0, t_B1, t_B2, t_B3, t_B4, t_B5, t_B6, t_B7, t_B8, t_B9 >

Public Member Functions

 Any ()
 
 Any (const std::string &id)
 
void build (const std::string &id)
 
bool isInitialized () const
 
t_Base * operator-> ()
 
const t_Base * operator-> () const
 
t_Base & operator * ()
 
const t_Base & operator * () const
 
void writeConfigEntries (ariles::WriterBase &writer, const ariles::ConfigurableFlags &param) const
 
void readConfigEntries (ariles::ReaderBase &reader, const ariles::ConfigurableFlags &parameters)
 
void arilesFinalize ()
 
void setDefaults ()
 
std::size_t getNumberOfEntries () const
 Get number of entries in the corresponding configuration node. More...
 
template<class t_Other >
bool arilesCompare (const t_Other &other, const ariles::ComparisonParameters &param) const
 
virtual const ConfigurableFlags & getArilesConfigurableFlags () const
 
virtual void finalize ()
 
virtual const std::string & getConfigSectionID () const =0
 Return the default name of a configuration node corresponding to this class. More...
 
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
 
template<class t_Derived >
t_Derived * cast ()
 Cast methods are potentially dangerous, no id checks are performed. If value is not initialized the returned pointer may be NULL. More...
 
template<class t_Derived >
const t_Derived * cast () const
 
template<class t_Derived >
t_Derived * cast (const std::string &config_section_id)
 These casts succeed if the Ariles config section id matches the given string. More...
 
template<class t_Derived >
const t_Derived * cast (const std::string &config_section_id) const
 

Public Attributes

std::string id_
 
t_Pointer< t_Base > value_
 

Protected Member Functions

bool isConsitent () const
 

Constructor & Destructor Documentation

◆ Any() [1/2]

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
ariles::Any< t_Pointer, t_Base, t_Instantiator >::Any ( )
inline

Definition at line 44 of file types.h.

◆ Any() [2/2]

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
ariles::Any< t_Pointer, t_Base, t_Instantiator >::Any ( const std::string &  id)
inline

Definition at line 50 of file types.h.

Member Function Documentation

◆ arilesCompare()

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
template<class t_Other >
bool ariles::Any< t_Pointer, t_Base, t_Instantiator >::arilesCompare ( const t_Other &  other,
const ariles::ComparisonParameters &  param 
) const
inline

Definition at line 203 of file types.h.

◆ arilesFinalize()

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
void ariles::Any< t_Pointer, t_Base, t_Instantiator >::arilesFinalize ( )
inlinevirtual

Implements ariles::CommonConfigurableBase.

Definition at line 181 of file types.h.

◆ build()

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
void ariles::Any< t_Pointer, t_Base, t_Instantiator >::build ( const std::string &  id)
inline

Definition at line 56 of file types.h.

◆ cast() [1/4]

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
template<class t_Derived >
t_Derived* ariles::Any< t_Pointer, t_Base, t_Instantiator >::cast ( )
inline

Cast methods are potentially dangerous, no id checks are performed. If value is not initialized the returned pointer may be NULL.

Definition at line 77 of file types.h.

◆ cast() [2/4]

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
template<class t_Derived >
const t_Derived* ariles::Any< t_Pointer, t_Base, t_Instantiator >::cast ( ) const
inline

Definition at line 84 of file types.h.

◆ cast() [3/4]

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
template<class t_Derived >
t_Derived* ariles::Any< t_Pointer, t_Base, t_Instantiator >::cast ( const std::string &  config_section_id)
inline

These casts succeed if the Ariles config section id matches the given string.

Definition at line 97 of file types.h.

◆ cast() [4/4]

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
template<class t_Derived >
const t_Derived* ariles::Any< t_Pointer, t_Base, t_Instantiator >::cast ( const std::string &  config_section_id) const
inline

Definition at line 111 of file types.h.

◆ finalize()

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

Reimplemented in demo::MyContainerClass.

Definition at line 87 of file ariles.h.

◆ getArilesConfigurableFlags()

virtual const ConfigurableFlags& ariles::ConfigurableBase::getArilesConfigurableFlags ( ) const
inlinevirtualinherited

Implements ariles::CommonConfigurableBase.

Definition at line 351 of file ariles.h.

◆ getConfigSectionID()

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

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

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
std::size_t ariles::Any< t_Pointer, t_Base, t_Instantiator >::getNumberOfEntries ( ) const
inlinevirtual

Get number of entries in the corresponding configuration node.

Returns
number of entries

Implements ariles::CommonConfigurableBase.

Definition at line 196 of file types.h.

◆ isConsitent()

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
bool ariles::Any< t_Pointer, t_Base, t_Instantiator >::isConsitent ( ) const
inlineprotected

Definition at line 22 of file types.h.

◆ isInitialized()

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
bool ariles::Any< t_Pointer, t_Base, t_Instantiator >::isInitialized ( ) const
inline

Definition at line 64 of file types.h.

◆ operator *() [1/2]

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
t_Base& ariles::Any< t_Pointer, t_Base, t_Instantiator >::operator * ( )
inline

Definition at line 139 of file types.h.

◆ operator *() [2/2]

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
const t_Base& ariles::Any< t_Pointer, t_Base, t_Instantiator >::operator * ( ) const
inline

Definition at line 146 of file types.h.

◆ operator->() [1/2]

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
t_Base* ariles::Any< t_Pointer, t_Base, t_Instantiator >::operator-> ( )
inline

Definition at line 125 of file types.h.

◆ operator->() [2/2]

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
const t_Base* ariles::Any< t_Pointer, t_Base, t_Instantiator >::operator-> ( ) const
inline

Definition at line 132 of file types.h.

◆ readConfig() [1/18]

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

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

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 virtualinherited

◆ readConfig() [4/18]

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

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 virtualinherited

◆ readConfig() [6/18]

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

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

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

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

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

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,
const ariles::ConfigurableFlags &  param 
)
inlineinherited

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

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

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

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

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

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

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

Definition at line 223 of file ariles.h.

◆ readConfigEntries()

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
void ariles::Any< t_Pointer, t_Base, t_Instantiator >::readConfigEntries ( ariles::ReaderBase &  reader,
const ariles::ConfigurableFlags &  parameters 
)
inlinevirtual

Reimplemented from ariles::CommonConfigurableBase.

Definition at line 169 of file types.h.

◆ setDefaults()

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
void ariles::Any< t_Pointer, t_Base, t_Instantiator >::setDefaults ( )
inlinevirtual

Reimplemented from ariles::CommonConfigurableBase.

Definition at line 189 of file types.h.

◆ writeConfig() [1/18]

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

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 ariles::ConfigurableFlags &  param 
) const
inlineinherited

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
inlineinherited

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 ariles::ConfigurableFlags &  param 
) const
inlineinherited

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
inlineinherited

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
inlineinherited

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 ariles::ConfigurableFlags &  param 
) const
inlineinherited

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
inlineinherited

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
inlineinherited

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
inlineinherited

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 ariles::ConfigurableFlags &  param 
) const
inlineinherited

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
inlineinherited

Definition at line 275 of file ariles.h.

◆ writeConfig() [13/18]

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

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
inlineinherited

Definition at line 290 of file ariles.h.

◆ writeConfig() [15/18]

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

◆ writeConfig() [16/18]

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

Definition at line 310 of file ariles.h.

◆ writeConfig() [17/18]

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

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 virtualinherited

◆ writeConfigEntries()

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
void ariles::Any< t_Pointer, t_Base, t_Instantiator >::writeConfigEntries ( ariles::WriterBase &  writer,
const ariles::ConfigurableFlags &  param 
) const
inlinevirtual

Reimplemented from ariles::CommonConfigurableBase.

Definition at line 155 of file types.h.

Member Data Documentation

◆ id_

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
std::string ariles::Any< t_Pointer, t_Base, t_Instantiator >::id_

Definition at line 39 of file types.h.

◆ value_

template<template< class > class t_Pointer, class t_Base , class t_Instantiator >
t_Pointer<t_Base> ariles::Any< t_Pointer, t_Base, t_Instantiator >::value_

Definition at line 40 of file types.h.

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