#include <string>
#include <utility>
#include <unordered_map>
#include <stdexcept>
#include <string_view>

Include dependency graph for configuration.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	adtf_file::PropertyValue
	PropertyValue variant class. More...

class	adtf_file::Configurable

class	adtf_file::PropertyBuilder< T >
	The PropertyBuilder class is an easy way to define a property with additional meta information. Multiple properties can be easily linked to an entire configuration using the "+" operator. More...

Namespaces
namespace	adtf_file
	namespace for ADTF File library

Macros
#define	FILE_PLUGIN_META_INFORMATION(version, description)
	Convenience to set version and description to adtffileplugin.

Typedefs
using	adtf_file::Configuration = std::unordered_map<std::string, PropertyValue>
	Configuration class as set of key - property value pairs This configuration is used to adjust the readers and processors behaviour.

Functions
bool	adtf_file::operator== (const PropertyValue &left, const PropertyValue &right)
	compare operator for PropertyValue

Configuration	adtf_file::operator+ (const Configuration &config_left, const Configuration &config_right)
	Add operator for configurations.

template<typename T>
T	adtf_file::getPropertyValue (const Configuration &configuration, const std::string &property_name)

template<typename T>
T	adtf_file::getPropertyValue (const Configuration &configuration, const std::string &property_name, const T &default_value)

Configuration	adtf_file::getSubConfiguration (const Configuration &configuration, const std::string &property_name, bool top_level_reserved_properties=false)
	Get a sub-tree of a configuration property.

template<typename T>
void	adtf_file::setPropertyValue (Configuration &configuration, const std::string &property_name, const T &property_value)

void	adtf_file::setFilePluginVersion (Configuration &configuration, const std::string &version)

void	adtf_file::setFilePluginDescription (Configuration &configuration, const std::string &description)

void	adtf_file::setPropertyDescription (Configuration &configuration, const std::string &property_name, const std::string &description)

void	adtf_file::setPropertyDisplayName (Configuration &configuration, const std::string &property_name, const std::string &display_name)

template<typename T>
void	adtf_file::setPropertyValueRange (Configuration &configuration, const std::string &property_name, const T &min, const T &max)

template<typename T>
void	adtf_file::setPropertyValueList (Configuration &configuration, const std::string &property_name, const std::vector< std::pair< T, std::string > > &value_list, bool restrict_to_values=true)

Detailed Description

This Source Code Form is subject to the terms of the Mozilla
Public License, v. 2.0. If a copy of the MPL was not distributed
with this file, You can obtain one at https://mozilla.org/MPL/2.0/.

If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.

You may add additional accurate notices of copyright ownership.

Macro Definition Documentation

◆ FILE_PLUGIN_META_INFORMATION

#define FILE_PLUGIN_META_INFORMATION	(		version,
			description )

Value:

    {                                                         \
        adtf_file::Configuration configuration;               \
        setFilePluginVersion(configuration, version);         \
        setFilePluginDescription(configuration, description); \
        setConfiguration(configuration);                      \
    }

Convenience to set version and description to adtffileplugin.

Classes

Namespaces

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ FILE_PLUGIN_META_INFORMATION