Security Scol plugin
Public Member Functions | Protected Attributes | List of all members
AlgorithmParametersTemplate< T > Class Template Reference

Template base class for AlgorithmParameters. More...

#include <algparam.h>

Inheritance diagram for AlgorithmParametersTemplate< T >:
AlgorithmParametersBase

Public Member Functions

 AlgorithmParametersTemplate (const char *name, const T &value, bool throwIfNotUsed)
 Construct an AlgorithmParametersTemplate.
 
void AssignValue (const char *name, const std::type_info &valueType, void *pValue) const
 
void MoveInto (void *buffer) const
 
- Public Member Functions inherited from AlgorithmParametersBase
 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 Attributes

m_value
 
- Protected Attributes inherited from AlgorithmParametersBase
const char * m_name
 
bool m_throwIfNotUsed
 
bool m_used
 
member_ptr< AlgorithmParametersBasem_next
 

Additional Inherited Members

- Protected Member Functions inherited from AlgorithmParametersBase
void operator= (const AlgorithmParametersBase &rhs)
 

Detailed Description

template<class T>
class AlgorithmParametersTemplate< T >

Template base class for AlgorithmParameters.

Template Parameters
Tthe class or type

Definition at line 370 of file algparam.h.

Constructor & Destructor Documentation

◆ AlgorithmParametersTemplate()

template<class T >
AlgorithmParametersTemplate< T >::AlgorithmParametersTemplate ( const char *  name,
const T &  value,
bool  throwIfNotUsed 
)
inline

Construct an AlgorithmParametersTemplate.

Parameters
namethe name of the value
valuea reference to the value
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 379 of file algparam.h.

Member Function Documentation

◆ AssignValue()

template<class T >
void AlgorithmParametersTemplate< T >::AssignValue ( const char *  name,
const std::type_info &  valueType,
void *  pValue 
) const
inlinevirtual

Implements AlgorithmParametersBase.

Definition at line 384 of file algparam.h.

◆ MoveInto()

template<class T >
void AlgorithmParametersTemplate< T >::MoveInto ( void *  buffer) const
inlinevirtual

Implements AlgorithmParametersBase.

Definition at line 401 of file algparam.h.

Member Data Documentation

◆ m_value

template<class T >
T AlgorithmParametersTemplate< T >::m_value
protected

Definition at line 412 of file algparam.h.


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