strus::SummarizerConfig Class Reference

Configuration describing the values passed to a summarizer function. More...

#include <bindingObjects.hpp>

Public Member Functions
	SummarizerConfig ()
	Constructor. More...
	SummarizerConfig (const SummarizerConfig &o)
	Copy constructor. More...
void	defineParameter (const String &name, const Variant &value)
	Define a summarizer parameter. More...
void	defineParameter (const String &name, const char *value)
	Define a summarizer parameter. More...
void	defineParameter (const String &name, int value)
	Define a summarizer parameter. More...
void	defineParameter (const String &name, unsigned int value)
	Define a summarizer parameter. More...
void	defineParameter (const String &name, double value)
	Define a summarizer parameter. More...
void	defineFeature (const String &sumtype, const String &set)
	Define a summarizer feature. More...
void	defineResultName (const String &origname, const String &newname)
	Rename a result (each summarizer result has a default name that can be changed with this method) More...

Friends
class	QueryEval

Detailed Description

Configuration describing the values passed to a summarizer function.

Constructor & Destructor Documentation

strus::SummarizerConfig::SummarizerConfig ( )

inline

Constructor.

strus::SummarizerConfig::SummarizerConfig ( const SummarizerConfig &  o )

inline

Copy constructor.

Member Function Documentation

void strus::SummarizerConfig::defineFeature ( const String &  sumtype, const String &  set  )

inline

Define a summarizer feature.

Parameters

[in]	sumtype	type name of the feature as defined in the summarizer implementation
[in]	set	feature set of the feature used to address the features

void strus::SummarizerConfig::defineParameter ( const String &  name, const Variant &  value  )

inline

Define a summarizer parameter.

Parameters

[in]	name	name of the parameter as defined in the summarizer implementation
[in]	value	value of the parameter

void strus::SummarizerConfig::defineParameter ( const String &  name, const char *  value  )

inline

Define a summarizer parameter.

Parameters

[in]	name	name of the parameter as defined in the summarizer implementation
[in]	value	value of the parameter

void strus::SummarizerConfig::defineParameter ( const String &  name, int  value  )

inline

Define a summarizer parameter.

Parameters

[in]	name	name of the parameter as defined in the summarizer implementation
[in]	value	value of the parameter

void strus::SummarizerConfig::defineParameter ( const String &  name, unsigned int  value  )

inline

Define a summarizer parameter.

Parameters

[in]	name	name of the parameter as defined in the summarizer implementation
[in]	value	value of the parameter

void strus::SummarizerConfig::defineParameter ( const String &  name, double  value  )

inline

Define a summarizer parameter.

Parameters

[in]	name	name of the parameter as defined in the summarizer implementation
[in]	value	value of the parameter

void strus::SummarizerConfig::defineResultName ( const String &  origname, const String &  newname  )

inline

Rename a result (each summarizer result has a default name that can be changed with this method)

Parameters

[in]	origname	original name of the result
[in]	newname	defined name of the result

Friends And Related Function Documentation

friend class QueryEval

friend

---

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

• /home/patrick/Projects/github/strusBindings/include/strus/bindingObjects.hpp