Ariles
Classes | Namespaces | Macros | Typedefs
ariles.h File Reference

Detailed Description

Author
Alexander Sherikov
Copyright
2014-2017 INRIA. Licensed under the Apache License, Version 2.0. (see LICENSE or http://www.apache.org/licenses/LICENSE-2.0)
2017-2019 Alexander Sherikov, Licensed under the Apache License, Version 2.0. (see LICENSE or http://www.apache.org/licenses/LICENSE-2.0)

Definition in file ariles.h.

Go to the source code of this file.

#include "ariles2.h"
#include "visitors/serialization.h"
#include "adapters/basic.h"
#include "types.h"

Classes

class  ariles::CommonConfigurableBase
 Configurable base class. More...
 
class  ariles::StrictConfigurableBase
 
class  ariles::RelaxedConfigurableBase
 
class  ariles::ConfigurableBase
 Default configurable base. More...
 

Namespaces

 ariles
 

Macros

#define ARILES_API_VERSION   1
 
#define ARILES_ENABLED
 
#define ARILES_INITIALIZE   "ariles/members/define_accessors.h"
 
#define ARILES_WRITE_NAMED_ENTRY(entry, name)   writer(entry, name, param);
 
#define ARILES_WRITE_ENTRY_(entry)   ARILES_WRITE_NAMED_ENTRY(entry##_, # entry)
 
#define ARILES_WRITE_ENTRY(entry)   ARILES_WRITE_NAMED_ENTRY(entry, # entry)
 
#define ARILES_WRITE_PARENT(parent_class)   parent_class::writeConfigEntries(writer, param);
 
#define ARILES_READ_NAMED_ENTRY(entry, name)   reader(entry, name, param);
 
#define ARILES_READ_ENTRY_(entry)   ARILES_READ_NAMED_ENTRY(entry##_, # entry);
 
#define ARILES_READ_ENTRY(entry)   ARILES_READ_NAMED_ENTRY(entry, # entry);
 
#define ARILES_READ_PARENT(parent_class)   parent_class::readConfigEntries(reader, param);
 
#define ARILES_READ_CONFIG(NameType)
 Read configuration (assuming the configuration node to be in the root). More...
 
#define ARILES_READ_CONFIG(InitializerType)
 Read configuration (assuming the configuration node to be in the root). More...
 
#define ARILES_READ_CONFIG(InitializerType, NameType)
 Read configuration (assuming the configuration node to be in the root). More...
 
#define ARILES_WRITE_CONFIG(InitializerType)
 Write configuration. More...
 
#define ARILES_WRITE_CONFIG(InitializerType, NameType)
 Write configuration. More...
 
#define ARILES_WRITE_CONFIG(NameType)
 Write configuration. More...
 

Typedefs

typedef serialization::Features ariles::BridgeFlags
 
typedef ariles::compare::Visitor::Parameters ariles::ComparisonParameters
 
typedef ariles::write::Visitor ariles::WriterBase
 
typedef ariles::read::Visitor ariles::ReaderBase
 

Macro Definition Documentation

◆ ARILES_API_VERSION

#define ARILES_API_VERSION   1

Definition at line 19 of file ariles.h.

◆ ARILES_ENABLED

#define ARILES_ENABLED

Definition at line 31 of file ariles.h.

◆ ARILES_INITIALIZE

#define ARILES_INITIALIZE   "ariles/members/define_accessors.h"

Definition at line 35 of file ariles.h.

◆ ARILES_READ_CONFIG [1/3]

#define ARILES_READ_CONFIG (   NameType)
Value:
virtual void readConfig( \
ariles::ReaderBase &reader, NameType node_name, const ariles::ReaderBase::Parameters &param) = 0; \
void readConfig(ariles::ReaderBase &reader, NameType node_name) \
{ \
ARILES_TRACE_FUNCTION; \
this->readConfig(reader, node_name, this->getArilesConfigurableFlags()); \
}

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

Parameters
[in]readerconfiguration reader
[in]node_namenode name, the default is used if empty
Note
Intercept implicit conversion of a pointer to bool.
Parameters
[in]file_namefile name
[in]file_namefile name
[in]node_namenode name, the default is used if empty
Note
Intercept implicit conversion of a pointer to bool.

Definition at line 203 of file ariles.h.

◆ ARILES_READ_CONFIG [2/3]

#define ARILES_READ_CONFIG (   InitializerType)
Value:
template <class t_Bridge, class t_ReaderInitializer> \
void readConfig(InitializerType &reader_initializer) \
{ \
ARILES_TRACE_FUNCTION; \
typename t_Bridge::Reader reader(reader_initializer); \
this->readConfig(reader, this->getConfigSectionID(), this->getArilesConfigurableFlags()); \
} \
template <class t_Bridge, class t_ReaderInitializer> \
void readConfig(InitializerType &reader_initializer, const ariles::ConfigurableFlags &param) \
{ \
ARILES_TRACE_FUNCTION; \
typename t_Bridge::Reader reader(reader_initializer); \
this->readConfig(reader, this->getConfigSectionID(), param); \
}
ariles::ns_msgpack::impl::Reader
class ARILES_VISIBILITY_ATTRIBUTE Reader
Definition: reader.h:22

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

Parameters
[in]readerconfiguration reader
[in]node_namenode name, the default is used if empty
Note
Intercept implicit conversion of a pointer to bool.
Parameters
[in]file_namefile name
[in]file_namefile name
[in]node_namenode name, the default is used if empty
Note
Intercept implicit conversion of a pointer to bool.

Definition at line 203 of file ariles.h.

◆ ARILES_READ_CONFIG [3/3]

#define ARILES_READ_CONFIG (   InitializerType,
  NameType 
)
Value:
template <class t_Bridge, class t_ReaderInitializer> \
void readConfig(InitializerType &reader_initializer, NameType node_name) \
{ \
ARILES_TRACE_FUNCTION; \
typename t_Bridge::Reader reader(reader_initializer); \
this->readConfig(reader, node_name, this->getArilesConfigurableFlags()); \
} \
template <class t_Bridge, class t_ReaderInitializer> \
void readConfig( \
InitializerType &reader_initializer, NameType node_name, const ariles::ConfigurableFlags &param) \
{ \
ARILES_TRACE_FUNCTION; \
typename t_Bridge::Reader reader(reader_initializer); \
this->readConfig(reader, node_name, param); \
}
ariles::ns_msgpack::impl::Reader
class ARILES_VISIBILITY_ATTRIBUTE Reader
Definition: reader.h:22

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

Parameters
[in]readerconfiguration reader
[in]node_namenode name, the default is used if empty
Note
Intercept implicit conversion of a pointer to bool.
Parameters
[in]file_namefile name
[in]file_namefile name
[in]node_namenode name, the default is used if empty
Note
Intercept implicit conversion of a pointer to bool.

Definition at line 203 of file ariles.h.

◆ ARILES_READ_ENTRY

#define ARILES_READ_ENTRY (   entry)    ARILES_READ_NAMED_ENTRY(entry, # entry);

Definition at line 49 of file ariles.h.

◆ ARILES_READ_ENTRY_

#define ARILES_READ_ENTRY_ (   entry)    ARILES_READ_NAMED_ENTRY(entry##_, # entry);

Definition at line 48 of file ariles.h.

◆ ARILES_READ_NAMED_ENTRY

#define ARILES_READ_NAMED_ENTRY (   entry,
  name 
)    reader(entry, name, param);

Definition at line 46 of file ariles.h.

◆ ARILES_READ_PARENT

#define ARILES_READ_PARENT (   parent_class)    parent_class::readConfigEntries(reader, param);

Definition at line 51 of file ariles.h.

◆ ARILES_WRITE_CONFIG [1/3]

#define ARILES_WRITE_CONFIG (   InitializerType)
Value:
template <class t_Bridge, class t_WriterInitializer> \
void writeConfig(InitializerType &writer_initializer) const \
{ \
typename t_Bridge::Writer writer(writer_initializer); \
this->writeConfig(writer, this->getArilesConfigurableFlags()); \
} \
template <class t_Bridge, class t_WriterInitializer> \
void writeConfig(InitializerType &writer_initializer, const ariles::ConfigurableFlags &param) const \
{ \
typename t_Bridge::Writer writer(writer_initializer); \
this->writeConfig(writer, param); \
}
ariles::ns_array::Writer
GenericWriter< NameValuePair > Writer
Definition: writer.h:257

Write configuration.

Parameters
[in]file_namefile name
[in]node_namenode name, the default is used if empty
[in,out]writerconfiguration writer
[in]node_namenode name, the default is used if empty

Definition at line 302 of file ariles.h.

◆ ARILES_WRITE_CONFIG [2/3]

#define ARILES_WRITE_CONFIG (   InitializerType,
  NameType 
)
Value:
template <class t_Bridge, class t_WriterInitializer> \
void writeConfig(InitializerType &writer_initializer, NameType node_name) const \
{ \
typename t_Bridge::Writer writer(writer_initializer); \
this->writeConfig(writer, node_name, this->getArilesConfigurableFlags()); \
} \
template <class t_Bridge, class t_WriterInitializer> \
void writeConfig( \
InitializerType &writer_initializer, NameType node_name, const ariles::ConfigurableFlags &param) const \
{ \
typename t_Bridge::Writer writer(writer_initializer); \
this->writeConfig(writer, node_name, param); \
}
ariles::ns_array::Writer
GenericWriter< NameValuePair > Writer
Definition: writer.h:257

Write configuration.

Parameters
[in]file_namefile name
[in]node_namenode name, the default is used if empty
[in,out]writerconfiguration writer
[in]node_namenode name, the default is used if empty

Definition at line 302 of file ariles.h.

◆ ARILES_WRITE_CONFIG [3/3]

#define ARILES_WRITE_CONFIG (   NameType)
Value:
virtual void writeConfig( \
ariles::WriterBase &writer, NameType node_name, const ariles::ConfigurableFlags &param) const = 0; \
void writeConfig(ariles::WriterBase &writer, NameType node_name) const \
{ \
this->writeConfig(writer, node_name, this->getArilesConfigurableFlags()); \
}

Write configuration.

Parameters
[in]file_namefile name
[in]node_namenode name, the default is used if empty
[in,out]writerconfiguration writer
[in]node_namenode name, the default is used if empty

Definition at line 302 of file ariles.h.

◆ ARILES_WRITE_ENTRY

#define ARILES_WRITE_ENTRY (   entry)    ARILES_WRITE_NAMED_ENTRY(entry, # entry)

Definition at line 41 of file ariles.h.

◆ ARILES_WRITE_ENTRY_

#define ARILES_WRITE_ENTRY_ (   entry)    ARILES_WRITE_NAMED_ENTRY(entry##_, # entry)

Definition at line 40 of file ariles.h.

◆ ARILES_WRITE_NAMED_ENTRY

#define ARILES_WRITE_NAMED_ENTRY (   entry,
  name 
)    writer(entry, name, param);

Definition at line 38 of file ariles.h.

◆ ARILES_WRITE_PARENT

#define ARILES_WRITE_PARENT (   parent_class)    parent_class::writeConfigEntries(writer, param);

Definition at line 43 of file ariles.h.

Generated by   doxygen 1.8.15