AlgorithmInformation Class Reference

#include <algorithminformation.h>

Public Types
using	ParameterType = AlgorithmParameter
using	ParameterListType = std::vector< ParameterType >

Public Member Functions
	AlgorithmInformation (const std::string id, const std::string name, const std::string description, const int year, const std::string author, const ParameterListType &parameters)
	~AlgorithmInformation ()
const std::string &	getId () const
const std::string &	getName () const
const std::string &	getDescription () const
int	getYear () const
const std::string &	getAuthor () const
const ParameterListType &	getParameters () const
const ParameterType &	getParameter (const std::string &id) const

Private Attributes
const std::string	mId
const std::string	mName
const std::string	mDescription
const int	mYear
const std::string	mAuthor
const ParameterListType	mParameters

Detailed Description

Definition at line 28 of file algorithminformation.h.

Member Typedef Documentation

using AlgorithmInformation::ParameterListType = std::vector<ParameterType>

Definition at line 32 of file algorithminformation.h.

using AlgorithmInformation::ParameterType = AlgorithmParameter

Definition at line 31 of file algorithminformation.h.

Constructor & Destructor Documentation

AlgorithmInformation::AlgorithmInformation	(	const std::string	id,
		const std::string	name,
		const std::string	description,
		const int	year,
		const std::string	author,
		const ParameterListType &	parameters
	)

Definition at line 23 of file algorithminformation.cpp.

AlgorithmInformation::~AlgorithmInformation

(

)

Definition at line 39 of file algorithminformation.cpp.

Member Function Documentation

const std::string& AlgorithmInformation::getAuthor ( ) const

inline

Definition at line 47 of file algorithminformation.h.

const std::string& AlgorithmInformation::getDescription ( ) const

inline

Definition at line 45 of file algorithminformation.h.

const std::string& AlgorithmInformation::getId ( ) const

inline

Definition at line 43 of file algorithminformation.h.

const std::string& AlgorithmInformation::getName ( ) const

inline

Definition at line 44 of file algorithminformation.h.

const AlgorithmInformation::ParameterType & AlgorithmInformation::getParameter

(

const std::string &

id

)

const

Definition at line 44 of file algorithminformation.cpp.

const ParameterListType& AlgorithmInformation::getParameters ( ) const

inline

Definition at line 48 of file algorithminformation.h.

int AlgorithmInformation::getYear ( ) const

inline

Definition at line 46 of file algorithminformation.h.

Member Data Documentation

const std::string AlgorithmInformation::mAuthor

private

Definition at line 56 of file algorithminformation.h.

const std::string AlgorithmInformation::mDescription

private

Definition at line 54 of file algorithminformation.h.

const std::string AlgorithmInformation::mId

private

Definition at line 52 of file algorithminformation.h.

const std::string AlgorithmInformation::mName

private

Definition at line 53 of file algorithminformation.h.

const ParameterListType AlgorithmInformation::mParameters

private

Definition at line 57 of file algorithminformation.h.

const int AlgorithmInformation::mYear

private

Definition at line 55 of file algorithminformation.h.

---

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

• /home/hinrichsen/Dokumente/Aktuell/EPT/Entropy-Piano-Tuner/core/calculation/algorithminformation.h
• /home/hinrichsen/Dokumente/Aktuell/EPT/Entropy-Piano-Tuner/core/calculation/algorithminformation.cpp