AlgorithmParametersBase Class Reference

Base class for AlgorithmParameters. More...

#include <algparam.h>

Inheritance diagram for AlgorithmParametersBase:

Collaboration diagram for AlgorithmParametersBase:

Classes
class	ParameterNotUsed
	Exception thrown when an AlgorithmParameter is unused. More...

Public Member Functions
virtual	~AlgorithmParametersBase () CRYPTOPP_THROW
	AlgorithmParametersBase (const AlgorithmParametersBase &x)
	AlgorithmParametersBase (const char *name, bool throwIfNotUsed)
	Construct a AlgorithmParametersBase. More...
bool	GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const

Protected Member Functions
void	operator= (const AlgorithmParametersBase &rhs)
virtual void	AssignValue (const char *name, const std::type_info &valueType, void *pValue) const =0
virtual void	MoveInto (void *p) const =0

Protected Attributes
const char *	m_name
bool	m_throwIfNotUsed
bool	m_used
member_ptr< AlgorithmParametersBase >	m_next

Friends
class	AlgorithmParameters

Detailed Description

Base class for AlgorithmParameters.

Definition at line 309 of file algparam.h.

Constructor & Destructor Documentation

virtual AlgorithmParametersBase::~AlgorithmParametersBase ( )

inlinevirtual

Definition at line 320 of file algparam.h.

AlgorithmParametersBase::AlgorithmParametersBase ( const AlgorithmParametersBase &  x )

inline

Definition at line 339 of file algparam.h.

AlgorithmParametersBase::AlgorithmParametersBase ( const char *  name, bool  throwIfNotUsed  )

inline

Construct a AlgorithmParametersBase.

Parameters

name	the parameter name
throwIfNotUsed	flags indicating whether an exception should be thrown

If throwIfNotUsed is true, then a ParameterNotUsed exception will be thrown in the destructor if the parameter is not not retrieved.

Definition at line 351 of file algparam.h.

Member Function Documentation

virtual void AlgorithmParametersBase::AssignValue ( const char *  name, const std::type_info &  valueType, void *  pValue  ) const

protectedpure virtual

Implemented in AlgorithmParametersTemplate< T >.

Here is the caller graph for this function:

bool AlgorithmParametersBase::GetVoidValue	(	const char *	name,
		const std::type_info &	valueType,
		void *	pValue
	)		const

Definition at line 28 of file algparam.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void AlgorithmParametersBase::MoveInto ( void *  p ) const

protectedpure virtual

Implemented in AlgorithmParametersTemplate< T >.

void AlgorithmParametersBase::operator= ( const AlgorithmParametersBase &  rhs )

protected

Definition at line 22 of file algparam.cpp.

Friends And Related Function Documentation

friend class AlgorithmParameters

friend

Definition at line 357 of file algparam.h.

Member Data Documentation

const char* AlgorithmParametersBase::m_name

protected

Definition at line 363 of file algparam.h.

member_ptr<AlgorithmParametersBase> AlgorithmParametersBase::m_next

protected

Definition at line 366 of file algparam.h.

bool AlgorithmParametersBase::m_throwIfNotUsed

protected

Definition at line 364 of file algparam.h.

bool AlgorithmParametersBase::m_used

mutableprotected

Definition at line 365 of file algparam.h.

---

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

• src/cryptopp/algparam.h
• src/cryptopp/algparam.cpp