Structure that describes a function (weighting or summarizer function) for introspection. More...

Classes
struct	Parameter
	Structure that describes a parameter. More...

Public Member Functions
FunctionDescription &	operator() (Parameter::Type type_, const std::string &name_, const std::string &text_, const std::string &domain_=std::string())
	Add a parameter description. More...

	FunctionDescription ()
	Default constructor. More...

	FunctionDescription (const std::string &text_)
	Constructor. More...

	FunctionDescription (const FunctionDescription &o)
	Copy constructor. More...

	FunctionDescription (const FunctionDescription &o, const std::string &text_)
	Derived constructor. More...

const std::string &	text () const
	Get the description text. More...

const std::vector< Parameter > &	parameter () const
	Get the description parameter list. More...

Detailed Description

Structure that describes a function (weighting or summarizer function) for introspection.

Constructor & Destructor Documentation

strus::FunctionDescription::FunctionDescription ( )

inline

Default constructor.

strus::FunctionDescription::FunctionDescription ( const std::string & text_ )

inlineexplicit

Constructor.

strus::FunctionDescription::FunctionDescription ( const FunctionDescription & o )

inline

Copy constructor.

strus::FunctionDescription::FunctionDescription	(	const FunctionDescription &	o,
		const std::string &	text_
	)

inline

Derived constructor.

FunctionDescription& strus::FunctionDescription::operator()	(	Parameter::Type	type_,
		const std::string &	name_,
		const std::string &	text_,
		const std::string &	domain_ = `std::string()`
	)

inline

Add a parameter description.

const std::vector<Parameter>& strus::FunctionDescription::parameter ( ) const

inline

Get the description parameter list.

const std::string& strus::FunctionDescription::text ( ) const

inline

Get the description text.

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