Crypto++  5.6.4
Free C++ class library of cryptographic schemes
Public Member Functions | List of all members
CombinedNameValuePairs Class Reference

Combines two sets of NameValuePairs. More...

+ Inheritance diagram for CombinedNameValuePairs:

Public Member Functions

 CombinedNameValuePairs (const NameValuePairs &pairs1, const NameValuePairs &pairs2)
 Construct a CombinedNameValuePairs. More...
 
bool GetVoidValue (const char *name, const std::type_info &valueType, void *pValue) const
 Get a named value. More...
 
- Public Member Functions inherited from NameValuePairs
template<class T >
bool GetThisObject (T &object) const
 Get a copy of this object or subobject. More...
 
template<class T >
bool GetThisPointer (T *&ptr) const
 Get a pointer to this object. More...
 
template<class T >
bool GetValue (const char *name, T &value) const
 Get a named value. More...
 
template<class T >
GetValueWithDefault (const char *name, T defaultValue) const
 Get a named value. More...
 
std::string GetValueNames () const
 Get a list of value names that can be retrieved. More...
 
bool GetIntValue (const char *name, int &value) const
 Get a named value with type int. More...
 
int GetIntValueWithDefault (const char *name, int defaultValue) const
 Get a named value with type int, with default. More...
 
template<class T >
void GetRequiredParameter (const char *className, const char *name, T &value) const
 Retrieves a required name/value pair. More...
 
void GetRequiredIntParameter (const char *className, const char *name, int &value) const
 Retrieves a required name/value pair. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from NameValuePairs
static void ThrowIfTypeMismatch (const char *name, const std::type_info &stored, const std::type_info &retrieving)
 Ensures an expected name and type is present. More...
 

Detailed Description

Combines two sets of NameValuePairs.

CombinedNameValuePairs allows you to provide two sets of of NameValuePairs. If a name is not found in the first set, then the second set is searched for the name and value pair. The second set of NameValuePairs often provides default values.

Definition at line 135 of file algparam.h.

Constructor & Destructor Documentation

CombinedNameValuePairs::CombinedNameValuePairs ( const NameValuePairs pairs1,
const NameValuePairs pairs2 
)
inline

Construct a CombinedNameValuePairs.

Parameters
pairs1reference to the first set of NameValuePairs
pairs2reference to the second set of NameValuePairs

Definition at line 141 of file algparam.h.

Member Function Documentation

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

Get a named value.

Parameters
namethe name of the object or value to retrieve
valueTypereference to a variable that receives the value
pValuevoid pointer to a variable that receives the value
Returns
true if the value was retrieved, false otherwise

GetVoidValue() retrives the value of name if it exists.

Note
GetVoidValue() is an internal function and should be implemented by derived classes. Users should use one of the other functions instead.
See also
GetValue(), GetValueWithDefault(), GetIntValue(), GetIntValueWithDefault(), GetRequiredParameter() and GetRequiredIntParameter()

Implements NameValuePairs.

Definition at line 14 of file algparam.cpp.


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