Security Scol plugin
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
AlgorithmParametersBase Class Referenceabstract

Base class for AlgorithmParameters. More...

#include <algparam.h>

Inheritance diagram for AlgorithmParametersBase:
AlgorithmParametersTemplate< T >

Classes

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

Public Member Functions

 AlgorithmParametersBase (const AlgorithmParametersBase &x)
 
 AlgorithmParametersBase (const char *name, bool throwIfNotUsed)
 Construct a AlgorithmParametersBase.
 
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< AlgorithmParametersBasem_next
 

Friends

class AlgorithmParameters
 

Detailed Description

Base class for AlgorithmParameters.

Definition at line 303 of file algparam.h.

Constructor & Destructor Documentation

◆ ~AlgorithmParametersBase()

virtual AlgorithmParametersBase::~AlgorithmParametersBase ( )
inlinevirtual

Definition at line 313 of file algparam.h.

◆ AlgorithmParametersBase() [1/2]

AlgorithmParametersBase::AlgorithmParametersBase ( const AlgorithmParametersBase x)
inline

Definition at line 337 of file algparam.h.

◆ AlgorithmParametersBase() [2/2]

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

Construct a AlgorithmParametersBase.

Parameters
namethe parameter name
throwIfNotUsedflags 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 349 of file algparam.h.

Member Function Documentation

◆ GetVoidValue()

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

Definition at line 26 of file algparam.cpp.

◆ operator=()

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

Definition at line 20 of file algparam.cpp.

Friends And Related Symbol Documentation

◆ AlgorithmParameters

friend class AlgorithmParameters
friend

Definition at line 355 of file algparam.h.

Member Data Documentation

◆ m_name

const char* AlgorithmParametersBase::m_name
protected

Definition at line 361 of file algparam.h.

◆ m_next

member_ptr<AlgorithmParametersBase> AlgorithmParametersBase::m_next
protected

Definition at line 364 of file algparam.h.

◆ m_throwIfNotUsed

bool AlgorithmParametersBase::m_throwIfNotUsed
protected

Definition at line 362 of file algparam.h.

◆ m_used

bool AlgorithmParametersBase::m_used
mutableprotected

Definition at line 363 of file algparam.h.


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