Template Class CParamValue

• Defined in File param_impl.h

Inheritance Relationships

Base Type

• public sdv::internal::CParamGuardian (Class CParamGuardian)

Class Documentation

template<typename TVar>
class CParamValue : public sdv::internal::CParamGuardian

Parameter value class.

Template Parameters:

TVar – Type of the parameter variable.

Public Functions

template<typename ...TInfoConstruct>
CParamValue(TVar &rtVar, bool bLockable, bool bAutoDirty, TInfoConstruct... tConstruct)

Constructor.

Template Parameters:

TInfoConstruct – The type of the variables that are provided to the constructor function of the parameter information.

Parameters:

• rtVar – [in] Reference to the parameter variable.

• bLockable – [in] When set, the parameter is lockable. Only use with writable parameters.

• bAutoDirty – [in] When set, the parameter dirty flag is detected automatically. Only use with writable parameters.

• tConstruct – [in] The construct function arguments.

virtual bool Set(const any_t &ranyValue) override

Set a value. Overload of CParamGuardian::Set.

Parameters:

ranyValue – [in] Reference to the value.

Returns:

Returns whether the parameter is writable and can be set.

virtual any_t Get() const override

Get a value. Overload of CParamGuardian::Get.

Returns:

Returns the value.