Abstract configuration for analyzers, to be implemented by algorithm classes. More...

#include <Config.hpp>

Inheritance diagram for crawlservpp::Module::Analyzer::Config:

Collaboration diagram for crawlservpp::Module::Analyzer::Config:

Classes
struct	Entries
	Configuration entries for analyzer threads. More...

Construction and Destruction
	Config ()=default
	Default constructor. More...

	~Config () override=default
	Default destructor. More...

Configuration
struct crawlservpp::Module::Analyzer::Config::Entries	config
	Configuration of the analyzer. More...

Copy and Move
The class is neither copyable, nor movable.
	Config (Config &)=delete
	Deleted copy constructor. More...

Config &	operator= (Config &)=delete
	Deleted copy assignment operator. More...

	Config (Config &&)=delete
	Deleted move constructor. More...

Config &	operator= (Config &&)=delete
	Deleted move assignment operator. More...

Analyzer-Specific Configuration Parsing
void	parseOption () override
	Parses an analyzer-specific configuration option. More...

void	checkOptions () override
	Checks the analyzer-specific configuration options. More...

void	reset () override
	Resets the analyzer-specific configuration options. More...

Algorithm-Specific Configuration Parsing
virtual void	parseAlgoOption ()=0
	Parses an algorithm-specific configuration entry. More...

virtual void	checkAlgoOptions ()=0
	Checks the algorithm-specific configuration. More...

virtual void	resetAlgo ()=0
	Resets the algorithm-specific configuration. More...

Configuration Loader
void	loadConfig (const std::string &configJson, LogQueue &warningsTo)
	Loads a configuration. More...

Parsing Options
enum	StringParsingOption { Default = 0, SQL, SubURL, URL, Trim }
	Options for parsing strings. More...

enum	CharParsingOption { FromNumber = 0, FromString }
	Options for parsing `char's`. More...

Configuration Parsing
void	category (const std::string &category)
	Sets the category of the subsequent configuration items to be checked for. More...

void	option (const std::string &name, bool &target)
	Checks for a configuration option of type `bool`. More...

void	option (const std::string &name, std::vector< bool > &target)
	Checks for a configuration option of type array of `bool's`. More...

void	option (const std::string &name, char &target, CharParsingOption opt)
	Checks for a configuration option of type `char`. More...

void	option (const std::string &name, std::vector< char > &target, CharParsingOption opt)
	Checks for a configuration option of type array of `char's`. More...

void	option (const std::string &name, std::int16_t &target)
	Checks for a configuration option of type 16-bit integer. More...

void	option (const std::string &name, std::vector< std::int16_t > &target)
	Checks for a configuration option of type array of 16-bit integers. More...

void	option (const std::string &name, std::int32_t &target)
	Checks for a configuration option of type 32-bit integer. More...

void	option (const std::string &name, std::vector< std::int32_t > &target)
	Checks for a configuration option of type array of 32-bit integers. More...

void	option (const std::string &name, std::int64_t &target)
	Checks for a configuration option of type 64-bit integer. More...

void	option (const std::string &name, std::vector< std::int64_t > &target)
	Checks for a configuration option of type array of 64-bit integers. More...

void	option (const std::string &name, std::uint8_t &target)
	Checks for a configuration option of type unsigned 8-bit integer. More...

void	option (const std::string &name, std::vector< std::uint8_t > &target)
	Checks for a configuration option of type array of unsigned 8-bit integers. More...

void	option (const std::string &name, std::uint16_t &target)
	Checks for a configuration option of type unsigned 16-bit integer. More...

void	option (const std::string &name, std::vector< std::uint16_t > &target)
	Checks for a configuration option of type array of unsigned 16-bit integers. More...

void	option (const std::string &name, std::uint32_t &target)
	Checks for a configuration option of type unsigned 32-bit integer. More...

void	option (const std::string &name, std::vector< std::uint32_t > &target)
	Checks for a configuration option of type array of unsigned 32-bit integers. More...

void	option (const std::string &name, std::uint64_t &target)
	Checks for a configuration option of type unsigned 64-bit integer. More...

void	option (const std::string &name, std::vector< std::uint64_t > &target)
	Checks for a configuration option of type array of unsigned 64-bit integers. More...

void	option (const std::string &name, float &target)
	Checks for a configuration option of type floating-point number. More...

void	option (const std::string &name, std::vector< float > &target)
	Checks for a configuration option of type array of floating-point numbers. More...

void	option (const std::string &name, std::string &target, StringParsingOption opt=Default)
	Checks for a configuration option of type string. More...

void	option (const std::string &name, std::vector< std::string > &target, StringParsingOption opt=Default)
	Checks for a configuration option of type array of strings. More...

void	warning (const std::string &warning)
	Adds a warning to the logging queue. More...

Module-specific Configuration Parsing
virtual void	parseBasicOption ()
	Parses a basic option. More...

virtual void	resetBase ()
	Resets basic options. More...

Detailed Description

Abstract configuration for analyzers, to be implemented by algorithm classes.

Member Enumeration Documentation

◆ CharParsingOption

enum crawlservpp::Module::Config::CharParsingOption

protectedinherited

Options for parsing char's.

Enumerator

FromNumber

Get char by its numeric value.

FromString

Get char from the beginning of a string.

Also supports certain escaped characters.

See also: Helper::Strings::getFirstOrEscapeChar

◆ StringParsingOption

enum crawlservpp::Module::Config::StringParsingOption

protectedinherited

Options for parsing strings.

Enumerator
Default	Uses a string as it is.
SQL	Requires a SQL-compatible string.
SubURL	Converts a string to a sub-URL.
URL	Converts a string to a URL (without the protocol).
Trim	Trims a string.

Constructor & Destructor Documentation

◆ Config() [1/3]

crawlservpp::Module::Analyzer::Config::Config ( )

default

Default constructor.

◆ ~Config()

crawlservpp::Module::Analyzer::Config::~Config ( )

overridevirtualdefault

Default destructor.

Reimplemented from crawlservpp::Module::Config.

◆ Config() [2/3]

crawlservpp::Module::Analyzer::Config::Config ( Config & )

delete

Deleted copy constructor.

◆ Config() [3/3]

crawlservpp::Module::Analyzer::Config::Config ( Config && )

delete

Deleted move constructor.

Member Function Documentation

◆ category()

void crawlservpp::Module::Config::category ( const std::string & category )

inlineprotectedinherited

Sets the category of the subsequent configuration items to be checked for.

Parameters

category Constant reference to a string containing the name of the category.

References crawlservpp::Struct::ConfigItem::category.

◆ checkAlgoOptions()

virtual void crawlservpp::Module::Analyzer::Config::checkAlgoOptions ( )

protectedpure virtual

Checks the algorithm-specific configuration.

Needs to be implemented by the (child) class for the specific algorithm.

Referenced by checkOptions().

◆ checkOptions()

void crawlservpp::Module::Analyzer::Config::checkOptions ( )

inlineoverrideprotectedvirtual

Checks the analyzer-specific configuration options.

Implements crawlservpp::Module::Config.

◆ loadConfig()

void crawlservpp::Module::Config::loadConfig	(	const std::string &	configJson,
		LogQueue &	warningsTo
	)

inlineinherited

Loads a configuration.

Parameters

configJson	Constant reference to a string containing the configuration as JSON.
warningsTo	Reference to a queue to which warnings will be added that occur during the parsing of the configuration, also known as the "logging queue".

Exceptions

Module::Config::Exception if the configuration JSON cannot be parsed.

References crawlservpp::Struct::ConfigItem::category, crawlservpp::Module::Config::checkOptions(), crawlservpp::Struct::ConfigItem::name, crawlservpp::Module::Config::parseBasicOption(), crawlservpp::Helper::Json::parseRapid(), crawlservpp::Struct::ConfigItem::str(), crawlservpp::Struct::ConfigItem::value, and crawlservpp::Main::Exception::view().

Referenced by crawlservpp::Module::Analyzer::Thread::cleanUpQueries(), crawlservpp::Module::Parser::Thread::onReset(), crawlservpp::Module::Extractor::Thread::onReset(), and crawlservpp::Module::Crawler::Thread::onReset().

◆ operator=() [1/2]

Config& crawlservpp::Module::Analyzer::Config::operator= ( Config & )

delete

Deleted copy assignment operator.

◆ operator=() [2/2]

Config& crawlservpp::Module::Analyzer::Config::operator= ( Config && )

delete

Deleted move assignment operator.

◆ option() [1/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		bool &	target
	)

inlineprotectedinherited

Checks for a configuration option of type bool.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a boolean variable into which the value of the configuration entry will be written if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

Referenced by crawlservpp::Module::Analyzer::Algo::Assoc::parseAlgoOption(), crawlservpp::Module::Analyzer::Algo::AssocOverTime::parseAlgoOption(), crawlservpp::Module::Analyzer::Algo::AllTokens::parseAlgoOption(), crawlservpp::Module::Analyzer::Algo::SentimentOverTime::parseAlgoOption(), crawlservpp::Module::Analyzer::Algo::TopicModelling::parseAlgoOption(), crawlservpp::Network::Config::parseBasicOption(), crawlservpp::Module::Parser::Config::parseOption(), parseOption(), crawlservpp::Module::Crawler::Config::parseOption(), and crawlservpp::Module::Extractor::Config::parseOption().

◆ option() [2/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< bool > &	target
	)

inlineprotectedinherited

Checks for a configuration option of type array of bool's.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector of `bool's` into which the value of the configuration entry will be written if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [3/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		char &	target,
		CharParsingOption	opt
	)

inlineprotectedinherited

Checks for a configuration option of type char.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a variable of the type `char` into which the value of the configuration entry will be written if it is encountered.
opt	Parsing options used for the configuration option.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Module::Config::FromNumber, crawlservpp::Module::Config::FromString, crawlservpp::Helper::Strings::getFirstOrEscapeChar(), crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [4/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< char > &	target,
		CharParsingOption	opt
	)

inlineprotectedinherited

Checks for a configuration option of type array of char's.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector of `char's` into which the value of the configuration entry will be written if it is encountered.
opt	Parsing options used for the configuration option.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Module::Config::FromNumber, crawlservpp::Module::Config::FromString, crawlservpp::Helper::Strings::getFirstOrEscapeChar(), crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [5/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::int16_t &	target
	)

inlineprotectedinherited

Checks for a configuration option of type 16-bit integer.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a variable into which the value of the configuration entry will be written if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [6/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< std::int16_t > &	target
	)

inlineprotectedinherited

Checks for a configuration option of type array of 16-bit integers.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector into which the value of the configuration entry will be stored if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [7/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::int32_t &	target
	)

inlineprotectedinherited

Checks for a configuration option of type 32-bit integer.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a variable into which the value of the configuration entry will be written if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [8/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< std::int32_t > &	target
	)

inlineprotectedinherited

Checks for a configuration option of type array of 32-bit integers.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector into which the value of the configuration entry will be stored if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [9/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::int64_t &	target
	)

inlineprotectedinherited

Checks for a configuration option of type 64-bit integer.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a variable into which the value of the configuration entry will be written if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [10/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< std::int64_t > &	target
	)

inlineprotectedinherited

Checks for a configuration option of type array of 64-bit integers.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector into which the value of the configuration entry will be stored if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [11/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::uint8_t &	target
	)

inlineprotectedinherited

Checks for a configuration option of type unsigned 8-bit integer.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a variable into which the value of the configuration entry will be written if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [12/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< std::uint8_t > &	target
	)

inlineprotectedinherited

Checks for a configuration option of type array of unsigned 8-bit integers.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector into which the value of the configuration entry will be stored if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [13/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::uint16_t &	target
	)

inlineprotectedinherited

Checks for a configuration option of type unsigned 16-bit integer.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a variable into which the value of the configuration entry will be written if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [14/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< std::uint16_t > &	target
	)

inlineprotectedinherited

Checks for a configuration option of type array of unsigned 16-bit integers.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector into which the value of the configuration entry will be stored if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [15/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::uint32_t &	target
	)

inlineprotectedinherited

Checks for a configuration option of type unsigned 32-bit integer.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a variable into which the value of the configuration entry will be written if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [16/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< std::uint32_t > &	target
	)

inlineprotectedinherited

Checks for a configuration option of type array of unsigned 32-bit integers.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector into which the value of the configuration entry will be stored if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [17/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::uint64_t &	target
	)

inlineprotectedinherited

Checks for a configuration option of type unsigned 64-bit integer.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a variable into which the value of the configuration entry will be written if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [18/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< std::uint64_t > &	target
	)

inlineprotectedinherited

Checks for a configuration option of type array of unsigned 64-bit integers.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector into which the value of the configuration entry will be stored if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [19/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		float &	target
	)

inlineprotectedinherited

Checks for a configuration option of type floating-point number.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a variable into which the value of the configuration entry will be written if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [20/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< float > &	target
	)

inlineprotectedinherited

Checks for a configuration option of type array of floating-point numbers.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector into which the value of the configuration entry will be stored if it is encountered.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Struct::ConfigItem::name, crawlservpp::Struct::ConfigItem::str(), and crawlservpp::Struct::ConfigItem::value.

◆ option() [21/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::string &	target,
		StringParsingOption	opt = `Default`
	)

inlineprotectedinherited

Checks for a configuration option of type string.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a string into which the value of the configuration entry will be stored if it is encountered.
opt	Parsing option for the configuration entry.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Helper::Strings::checkSQLName(), crawlservpp::Module::Config::Default, crawlservpp::Struct::ConfigItem::name, crawlservpp::Module::Config::SQL, crawlservpp::Struct::ConfigItem::str(), crawlservpp::Module::Config::SubURL, crawlservpp::Helper::Strings::trim(), crawlservpp::Module::Config::Trim, crawlservpp::Module::Config::URL, and crawlservpp::Struct::ConfigItem::value.

◆ option() [22/22]

void crawlservpp::Module::Config::option	(	const std::string &	name,
		std::vector< std::string > &	target,
		StringParsingOption	opt = `Default`
	)

inlineprotectedinherited

Checks for a configuration option of type array of strings.

Ignores the option and adds a warning to the warnings queue, if the requested type does not match the data type in the configuration JSON.

Parameters

name	Constant reference to a string containing the name of the option to check for.
target	Reference to a vector into which the value of the configuration entry will be stored if it is encountered.
opt	Parsing option for the configuration entry.

Exceptions

Module::Config::Exception if no category has been set.

See also: category

References crawlservpp::Helper::Strings::checkSQLName(), crawlservpp::Module::Config::Default, crawlservpp::Struct::ConfigItem::name, crawlservpp::Module::Config::SQL, crawlservpp::Struct::ConfigItem::str(), crawlservpp::Module::Config::SubURL, crawlservpp::Helper::Strings::trim(), crawlservpp::Module::Config::Trim, crawlservpp::Module::Config::URL, and crawlservpp::Struct::ConfigItem::value.

◆ parseAlgoOption()

virtual void crawlservpp::Module::Analyzer::Config::parseAlgoOption ( )

protectedpure virtual

Parses an algorithm-specific configuration entry.

Needs to be implemented by the (child) class for the specific algorithm.

Referenced by parseOption().

◆ parseBasicOption()

void crawlservpp::Module::Config::parseBasicOption ( )

inlineprotectedvirtualinherited

Parses a basic option.

Might be overridden by child classes.

Can be used by abstract classes to add additional configuration entries without being the final implementation, as in Network::Config.

Warning: Any reimplementation needs to call parseOption() for the configuration to work properly.

See also: Network::Config::parseBasicOption

Reimplemented in crawlservpp::Network::Config.

References crawlservpp::Module::Config::parseOption().

Referenced by crawlservpp::Module::Config::loadConfig().

◆ parseOption()

void crawlservpp::Module::Analyzer::Config::parseOption ( )

inlineoverrideprotectedvirtual

Parses an analyzer-specific configuration option.

Implements crawlservpp::Module::Config.

◆ reset()

void crawlservpp::Module::Analyzer::Config::reset ( )

inlineoverrideprotectedvirtual

Resets the analyzer-specific configuration options.

Implements crawlservpp::Module::Config.

References config, and resetAlgo().

◆ resetAlgo()

virtual void crawlservpp::Module::Analyzer::Config::resetAlgo ( )

protectedpure virtual

Resets the algorithm-specific configuration.

Needs to be implemented by the (child) class for the specific algorithm.

Referenced by crawlservpp::Module::Analyzer::Thread::onReset(), and reset().

◆ resetBase()

void crawlservpp::Module::Config::resetBase ( )

inlineprotectedvirtualinherited

Resets basic options.

Might be overridden by child classes.

Can be used by abstract classes to reset additional configuration entries without being the final implementation, as in Network::Config.

Warning: Any reimplementation needs to call reset() for the reset to work properly.

See also: Network::Config::resetBase

Reimplemented in crawlservpp::Network::Config.

References crawlservpp::Module::protocols, and crawlservpp::Module::Config::reset().

Referenced by crawlservpp::Module::Analyzer::Thread::onReset(), and crawlservpp::Module::Parser::Thread::onReset().

◆ warning()

void crawlservpp::Module::Config::warning ( const std::string & warning )

inlineprotectedinherited

Adds a warning to the logging queue.

Warning: Should not be used outside of Config::loadConfig!

Parameters

warning Constant reference to a string containing the warning.

Exceptions

Module::Config::Exception if no log queue is active.

Referenced by crawlservpp::Module::Analyzer::Algo::Assoc::checkAlgoOptions(), crawlservpp::Module::Analyzer::Algo::AssocOverTime::checkAlgoOptions(), crawlservpp::Module::Analyzer::Algo::SentimentOverTime::checkAlgoOptions(), crawlservpp::Module::Parser::Config::checkOptions(), checkOptions(), crawlservpp::Module::Crawler::Config::checkOptions(), crawlservpp::Module::Extractor::Config::checkOptions(), and crawlservpp::Network::Config::parseBasicOption().

Member Data Documentation

◆ config

struct crawlservpp::Module::Analyzer::Config::Entries crawlservpp::Module::Analyzer::Config::config

Configuration of the analyzer.

The documentation for this class was generated from the following file:

Module/Analyzer/Config.hpp

Classes

Construction and Destruction

Configuration

Copy and Move

Analyzer-Specific Configuration Parsing

Algorithm-Specific Configuration Parsing

Configuration Loader

Parsing Options

Configuration Parsing

Module-specific Configuration Parsing

Detailed Description

Member Enumeration Documentation

◆ CharParsingOption

◆ StringParsingOption

Constructor & Destructor Documentation

◆ Config() [1/3]

◆ ~Config()

◆ Config() [2/3]

◆ Config() [3/3]

Member Function Documentation

◆ category()

◆ checkAlgoOptions()

◆ checkOptions()

◆ loadConfig()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ option() [1/22]

◆ option() [2/22]

◆ option() [3/22]

◆ option() [4/22]

◆ option() [5/22]

◆ option() [6/22]

◆ option() [7/22]

◆ option() [8/22]

◆ option() [9/22]

◆ option() [10/22]

◆ option() [11/22]

◆ option() [12/22]

◆ option() [13/22]

◆ option() [14/22]

◆ option() [15/22]

◆ option() [16/22]

◆ option() [17/22]

◆ option() [18/22]

◆ option() [19/22]

◆ option() [20/22]

◆ option() [21/22]

◆ option() [22/22]

◆ parseAlgoOption()

◆ parseBasicOption()

◆ parseOption()

◆ reset()

◆ resetAlgo()

◆ resetBase()

◆ warning()

Member Data Documentation

◆ config