algparam.h File Reference

Classes for working with NameValuePairs. More...

Go to the source code of this file.

Classes
class	ConstByteArrayParameter
	used to pass byte array input as part of a NameValuePairs object More...
class	ByteArrayParameter
class	CombinedNameValuePairs
class	GetValueHelperClass< T, BASE >
class	AssignFromHelperClass< T, BASE >
class	AlgorithmParametersBase
class	AlgorithmParametersBase::ParameterNotUsed
class	AlgorithmParametersTemplate< T >
class	AlgorithmParameters
	An object that implements NameValuePairs. More...
Defines
#define	CRYPTOPP_GET_FUNCTION_ENTRY(name)   (Name::name(), &ThisClass::Get##name)
#define	CRYPTOPP_SET_FUNCTION_ENTRY(name)   (Name::name(), &ThisClass::Set##name)
#define	CRYPTOPP_SET_FUNCTION_ENTRY2(name1, name2)   (Name::name1(), Name::name2(), &ThisClass::Set##name1##And##name2)
Typedefs
typedef bool(CRYPTOPP_API *	PAssignIntToInteger )(const std::type_info &valueType, void *pInteger, const void *pInt)
Functions
template<class BASE , class T >
GetValueHelperClass< T, BASE >	GetValueHelper (const T *pObject, const char *name, const std::type_info &valueType, void *pValue, const NameValuePairs *searchFirst=NULL, BASE *dummy=NULL)
template<class T >
GetValueHelperClass< T, T >	GetValueHelper (const T *pObject, const char *name, const std::type_info &valueType, void *pValue, const NameValuePairs *searchFirst=NULL)
template<class BASE , class T >
AssignFromHelperClass< T, BASE >	AssignFromHelper (T *pObject, const NameValuePairs &source, BASE *dummy=NULL)
template<class T >
AssignFromHelperClass< T, T >	AssignFromHelper (T *pObject, const NameValuePairs &source)
CRYPTOPP_DLL const std::type_info &CRYPTOPP_API	IntegerTypeId ()
template<class T >
AlgorithmParameters	MakeParameters (const char *name, const T &value, bool throwIfNotUsed=true)
	Create an object that implements NameValuePairs.
Variables
CRYPTOPP_DLL PAssignIntToInteger	g_pAssignIntToInteger
CRYPTOPP_DLL_TEMPLATE_CLASS	AlgorithmParametersTemplate< bool >
CRYPTOPP_DLL_TEMPLATE_CLASS	AlgorithmParametersTemplate< int >
CRYPTOPP_DLL_TEMPLATE_CLASS	AlgorithmParametersTemplate< ConstByteArrayParameter >

---

Detailed Description

Classes for working with NameValuePairs.

Definition in file algparam.h.

---

Function Documentation

template<class T >

AlgorithmParameters MakeParameters	(	const char *	name,
		const T &	value,
		bool	throwIfNotUsed = true
	)			[inline]

Create an object that implements NameValuePairs.

Template Parameters:

T

the class or type

Parameters:

	name	the name of the object or value to retrieve
	value	reference to a variable that receives the value
	throwIfNotUsed	if true, the object will throw an exception if the value is not accessed

Note:

throwIfNotUsed is ignored if using a compiler that does not support std::uncaught_exception(), such as MSVC 7.0 and earlier.

A NameValuePairs object containing an arbitrary number of name value pairs may be constructed by repeatedly using operator() on the object returned by MakeParameters, for example:

        AlgorithmParameters parameters = MakeParameters(name1, value1)(name2, value2)(name3, value3);
      

Definition at line 487 of file algparam.h.

Referenced by AuthenticatedDecryptionFilter::AuthenticatedDecryptionFilter(), Base32Encoder::Base32Encoder(), Base64Encoder::Base64Encoder(), Base64URLEncoder::Base64URLEncoder(), BaseN_Decoder::BaseN_Decoder(), BaseN_Encoder::BaseN_Encoder(), Deflator::Deflator(), InvertibleRWFunction::GenerateRandom(), DL_GroupParameters_DSA::GenerateRandom(), InvertibleESIGNFunction::GenerateRandom(), GeneratableCryptoMaterial::GenerateRandomWithKeySize(), Grouper::Grouper(), IntegrityCheckModule(), HexDecoder::IsolatedInitialize(), HexEncoder::IsolatedInitialize(), Base64URLEncoder::IsolatedInitialize(), Base64Encoder::IsolatedInitialize(), Base32Decoder::IsolatedInitialize(), Base32Encoder::IsolatedInitialize(), Integer::Randomize(), SimpleKeyingInterface::SetKeyWithIV(), SimpleKeyingInterface::SetKeyWithRounds(), and StringSource::StringSource().